Deployment health

GET

/api/v1/health/status

curl --request GET \
  --url https://example.com/api/v1/health/status \
  --header 'Authorization: <Authorization>'

Component health, per-service runtime detail and upgrade status. Admin only.

Authorizations

• ApiKeyAuth

Responses

200

OK

Media typeapplication/json

object

components

Array<object>

object

details

object

key

additional properties

id

string

name

string

status

string

summary

string

generated_at

string

upgrade

object

api_version

API and TLS expose the per-service versions behind Skew so the page can name both sides of a mismatch.

string

checked

boolean

checked_at

string

current

string

latest

string

more_information

string

skew

boolean

suggested

string

tls_version

string

up_to_date

boolean

Example^generated

{
  "components": [
    {
      "details": {
        "additionalProperty": "example"
      },
      "id": "example",
      "name": "example",
      "status": "example",
      "summary": "example"
    }
  ],
  "generated_at": "example",
  "upgrade": {
    "api_version": "example",
    "checked": true,
    "checked_at": "example",
    "current": "example",
    "latest": "example",
    "more_information": "example",
    "skew": true,
    "suggested": "example",
    "tls_version": "example",
    "up_to_date": true
  }
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Health reporting disabled

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}