putty
API ReferenceMeta

Read service metadata

Returns the identity of the running API: its name, the version of the HTTP contract, and the path of its OpenAPI document. Useful as a smoke test that the service is up and which build answered.

GET
/

Returns the identity of the running API: its name, the version of the HTTP contract, and the path of its OpenAPI document. Useful as a smoke test that the service is up and which build answered.

Response Body

application/json

application/json

curl -X GET "https://example.com"
{  "name": "string",  "version": "string",  "openapi": "string"}

Overview

What this reference covers, and how the sidebar is organised.

Check liveness GET

Reports whether the process is serving traffic. It performs no dependency checks, so a 200 means the API answered, not that its downstreams are healthy.