Return the readiness probe

GET

/ready

const url = 'https://example.com/ready';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Responses

200

Evidence runtime is ready

application/json

Example

{
  "checks": {
    "failed": 0,
    "ok": 1,
    "total": 1
  },
  "status": "ready"
}

503

Evidence runtime is not ready or is degraded

application/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": "readiness.not_ready",
  "detail": "one or more readiness checks are not ready",
  "status": 503,
  "title": "Evidence runtime is not ready",
  "type": "https://docs.registry-notary.dev/problems/readiness/not_ready"
}

4XX

Client error

application/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",
  "status": 400,
  "title": "Invalid evidence request",
  "type": "https://docs.registry-notary.dev/problems/request/invalid"
}