Retrieve the OpenAPI document

GET/openapi.json

Returns the latest published release of the API v3 OpenAPI document. Any authenticated credential can retrieve it.

The response includes an ETag derived from the document content. Send this value in the If-None-Match header to receive 304 Not Modified when the document has not changed.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/openapi.json"
{}