Report that the process can serve document routes.

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

Answers 200 while the database is reachable, the activation ledger names this process’s package active, and the audit journal accepts writes; otherwise service.unavailable.

Responses

200

The operation succeeded. The body is empty.

405

A problem: request.method-not-allowed.

application/problem+json

object

code

required

string

Allowed values: authentication.refused custody.not-permitted custody.quota-exceeded document-grant.expiry-out-of-range document-policy.unknown document-version.not-releasable document.content-type-not-allowed document.too-large idempotency.expired idempotency.key-reused profile.not-authorized request.body-too-large request.invalid request.method-not-allowed request.not-found request.unprocessable request.unsupported-media-type resource.not-found service.unavailable upload.content-type-mismatch upload.digest-mismatch upload.expired upload.finalized upload.length-mismatch

detail

required

string

status

required

integer

title

required

string

traceId

required

string

type

required

string

Allowed values: https://id.registrystack.org/problems/registry-documents/authentication/refused https://id.registrystack.org/problems/registry-documents/custody/not-permitted https://id.registrystack.org/problems/registry-documents/custody/quota-exceeded https://id.registrystack.org/problems/registry-documents/document-grant/expiry-out-of-range https://id.registrystack.org/problems/registry-documents/document-policy/unknown https://id.registrystack.org/problems/registry-documents/document-version/not-releasable https://id.registrystack.org/problems/registry-documents/document/content-type-not-allowed https://id.registrystack.org/problems/registry-documents/document/too-large https://id.registrystack.org/problems/registry-documents/idempotency/expired https://id.registrystack.org/problems/registry-documents/idempotency/key-reused https://id.registrystack.org/problems/registry-documents/profile/not-authorized https://id.registrystack.org/problems/registry-documents/request/body-too-large https://id.registrystack.org/problems/registry-documents/request/invalid https://id.registrystack.org/problems/registry-documents/request/method-not-allowed https://id.registrystack.org/problems/registry-documents/request/not-found https://id.registrystack.org/problems/registry-documents/request/unprocessable https://id.registrystack.org/problems/registry-documents/request/unsupported-media-type https://id.registrystack.org/problems/registry-documents/resource/not-found https://id.registrystack.org/problems/registry-documents/service/unavailable https://id.registrystack.org/problems/registry-documents/upload/content-type-mismatch https://id.registrystack.org/problems/registry-documents/upload/digest-mismatch https://id.registrystack.org/problems/registry-documents/upload/expired https://id.registrystack.org/problems/registry-documents/upload/finalized https://id.registrystack.org/problems/registry-documents/upload/length-mismatch

code

required

Allowed values: request.method-not-allowed

Example

{
  "code": "request.method-not-allowed",
  "type": "https://id.registrystack.org/problems/registry-documents/authentication/refused"
}

503

A problem: service.unavailable.

application/problem+json

object

code

required

string

detail

required

string

status

required

integer

title

required

string

traceId

required

string

type

required

string

code

required

Allowed values: service.unavailable

Example

{
  "code": "service.unavailable",
  "type": "https://id.registrystack.org/problems/registry-documents/authentication/refused"
}

Headers

Retry-After

required

integer

>= 1

Whole seconds to wait before trying again.