Skip to content
Haddon

Readiness: migrations, the writer, the pinned verifier and the cursor keyring

GET
/readyz
curl --request GET \
  --url https://example.com/readyz

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Readiness
object
status
required
Status
string
checks
required
Checks
Array<object>
Check
object
name
required
Name
string
ok
required
Ok
boolean
detail
required
Detail
string

Example generated

{
  "status": "example",
  "checks": [
    {
      "name": "example",
      "ok": true,
      "detail": "example"
    }
  ]
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
Readiness
object
status
required
Status
string
checks
required
Checks
Array<object>
Check
object
name
required
Name
string
ok
required
Ok
boolean
detail
required
Detail
string

Example generated

{
  "status": "example",
  "checks": [
    {
      "name": "example",
      "ok": true,
      "detail": "example"
    }
  ]
}