Report fail-closed runtime readiness

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

Runtime is ready

application/json

object

status

required

string

Allowed values: ready

Example

{
  "status": "ready"
}

Headers

Cache-Control

string

Allowed values: no-store

Evidence responses are never cacheable.

traceparent

string

/^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Effective W3C trace context. One valid inbound traceparent is retained; missing, invalid, or duplicate values are replaced and tracestate is never reflected.

503

Runtime is not ready

application/problem+json

object

One of:

Evidence public problem Version 1

object

code

required

string

Allowed values: evidence.invalid-request

detail

required

string

Allowed values: the Evidence request is invalid

status

required

integer

Allowed values: 400

title

required

string

Allowed values: Evidence request is invalid

traceId

required

string

/^(?!0{32}$)[0-9a-f]{32}$/

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/evidence/invalid-request

code

required

string

Allowed values: service.unavailable

detail

required

string

Allowed values: the request could not be served

status

required

integer

Allowed values: 503

title

required

string

Allowed values: Service is unavailable

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-evidence/service/unavailable

Example

{
  "code": "service.unavailable",
  "detail": "the request could not be served",
  "status": 503,
  "title": "Service is unavailable",
  "type": "https://id.registrystack.org/problems/registry-evidence/service/unavailable"
}

Headers

Cache-Control

string

Allowed values: no-store

Evidence responses are never cacheable.

traceparent

string

/^00-(?!0{32}-)[0-9a-f]{32}-(?!0{16}-)[0-9a-f]{16}-[0-9a-f]{2}$/

Effective W3C trace context. One valid inbound traceparent is retained; missing, invalid, or duplicate values are replaced and tracestate is never reflected.