Skip to content
Registry StackDocsDocumentation preview
Search

Return the readiness probe

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

Responses

Section titled “Responses”

200

Section titled “200”

Evidence runtime is ready

Media typeapplication/json
object
checks
required
object
degraded
required
integer
failed
required
integer
ok
required
integer
relay
required
object
failed
required
integer
ok
required
integer
total
required
integer
signing_providers
required
object
custody
required
object
active_provider_counts
required

Counts by configured provider kind. PKCS#11 identifies an interface, not whether custody is hardware- or software-backed.

object
key
additional properties
integer
custody_approval_required
required
boolean
custody_approved
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
surfaces
required
object
access_token_issuance
required
object
enabled
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
credential_issuance
required
object
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
federation
required
object
enabled
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
failed
required
integer
ok
required
integer
total
required
integer
total
required
integer
status
required
string
Allowed values: ready
Example
{
  "checks": {
    "degraded": 0,
    "failed": 0,
    "ok": 3,
    "relay": {
      "failed": 0,
      "ok": 1,
      "total": 1
    },
    "signing_providers": {
      "custody": {
        "active_provider_counts": {
          "pkcs11": 1
        },
        "custody_approval_required": true,
        "custody_approved": true,
        "local_software_signing_provider_count": 0,
        "signing_provider_count": 1,
        "surfaces": {
          "access_token_issuance": {
            "enabled": false,
            "local_software_signing_provider_count": 0,
            "signing_provider_count": 0,
            "unapproved_signing_provider_count": 0
          },
          "credential_issuance": {
            "local_software_signing_provider_count": 0,
            "signing_provider_count": 1,
            "unapproved_signing_provider_count": 0
          },
          "federation": {
            "enabled": false,
            "local_software_signing_provider_count": 0,
            "signing_provider_count": 0,
            "unapproved_signing_provider_count": 0
          }
        },
        "unapproved_signing_provider_count": 0
      },
      "failed": 0,
      "ok": 1,
      "total": 1
    },
    "total": 3
  },
  "status": "ready"
}

503

Section titled “503”

Evidence runtime is not ready, is degraded, or has an inconsistent audit chain

Media typeapplication/problem+json
One of:
object
checks
required
object
degraded
required
integer
failed
required
integer
ok
required
integer
relay
required
object
failed
required
integer
ok
required
integer
total
required
integer
signing_providers
required
object
custody
required
object
active_provider_counts
required

Counts by configured provider kind. PKCS#11 identifies an interface, not whether custody is hardware- or software-backed.

object
key
additional properties
integer
custody_approval_required
required
boolean
custody_approved
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
surfaces
required
object
access_token_issuance
required
object
enabled
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
credential_issuance
required
object
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
federation
required
object
enabled
required
boolean
local_software_signing_provider_count
required
integer
signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
unapproved_signing_provider_count
required
integer
failed
required
integer
ok
required
integer
total
required
integer
total
required
integer
code
required
string
Allowed values: readiness.not_ready
detail
required
string
Allowed values: one or more readiness checks are not ready
readiness_status
required
string
Allowed values: degraded not_ready
request_id
required
string
<= 128 characters
status
required
integer format: int32
Allowed values: 503
title
required
string
Allowed values: Evidence runtime is not ready
type
required
string format: uri
Allowed values: https://id.registrystack.org/problems/registry-notary/readiness/not-ready
Examples

The retained audit chain failed integrity verification

{
  "code": "audit.chain.inconsistent",
  "detail": "the retained audit chain has an integrity failure and requires operator recovery",
  "request_id": "01J00000000000000000000000",
  "status": 503,
  "title": "Audit chain inconsistent",
  "type": "https://id.registrystack.org/problems/registry-notary/audit/chain-inconsistent"
}

4XX

Section titled “4XX”

Client error

Media typeapplication/problem+json
object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "request.invalid",
  "detail": "the evidence request is invalid",
  "request_id": "01J00000000000000000000000",
  "status": 400,
  "title": "Invalid evidence request",
  "type": "https://id.registrystack.org/problems/registry-notary/request/invalid"
}