⌘K

Meta

Health and documentation. No API key required.

GET/healthLiveness and deployed version

Liveness and deployed version

Public: this route is mounted before authentication.

The API is serving.

{
  "status": null,
  "version": ""
}

boltTry it

env

GET/api/v1/health

curl -X GET '/api/v1/health'

GET/openapi.jsonThis document

This document

Public. servers[0].url is rewritten from the request host so the document points back at the deployment that served it.

The OpenAPI 3.1 document.

null

boltTry it

env

GET/api/v1/openapi.json

curl -X GET '/api/v1/openapi.json'

GET/docsRendered reference

Rendered reference

Public. An HTML page that renders /api/v1/openapi.json with ReDoc.

The documentation page.

null

boltTry it

env

GET/api/v1/docs

curl -X GET '/api/v1/docs'