Health

GET

/health

const url = 'https://example.com/health';
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/health

Parameters

Header Parameters

traceparent

string

Responses

200

Success

Headers

traceparent

string

W3C trace context.

400

Problem: request.invalid

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 value: request.invalid

detail

required

Allowed value: The Casework request is invalid.

status

required

Allowed value: 400

title

required

Allowed value: Invalid request

type

required

Allowed value: https://id.registrystack.org/problems/registry-casework/request/invalid

Example

{
  "code": "request.invalid",
  "detail": "The Casework request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-casework/request/invalid"
}

Headers

traceparent

string

W3C trace context.

413

Problem: request.body-too-large

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 value: request.body-too-large

detail

required

Allowed value: The request body exceeds the one MiB limit.

status

required

Allowed value: 413

title

required

Allowed value: Request body too large

type

required

Allowed value: https://id.registrystack.org/problems/registry-casework/request/body-too-large

Example

{
  "code": "request.body-too-large",
  "detail": "The request body exceeds the one MiB limit.",
  "status": 413,
  "title": "Request body too large",
  "type": "https://id.registrystack.org/problems/registry-casework/request/body-too-large"
}

Headers

traceparent

string

W3C trace context.

415

Problem: request.unsupported-media-type

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 value: request.unsupported-media-type

detail

required

Allowed value: Send a JSON request body with Content-Type application/json.

status

required

Allowed value: 415

title

required

Allowed value: Unsupported media type

type

required

Allowed value: https://id.registrystack.org/problems/registry-casework/request/unsupported-media-type

Example

{
  "code": "request.unsupported-media-type",
  "detail": "Send a JSON request body with Content-Type application/json.",
  "status": 415,
  "title": "Unsupported media type",
  "type": "https://id.registrystack.org/problems/registry-casework/request/unsupported-media-type"
}

Headers

traceparent

string

W3C trace context.

422

Problem: request.unprocessable

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 value: request.unprocessable

detail

required

Allowed value: The request body does not match the Casework contract.

status

required

Allowed value: 422

title

required

Allowed value: Request could not be processed

type

required

Allowed value: https://id.registrystack.org/problems/registry-casework/request/unprocessable

Example

{
  "code": "request.unprocessable",
  "detail": "The request body does not match the Casework contract.",
  "status": 422,
  "title": "Request could not be processed",
  "type": "https://id.registrystack.org/problems/registry-casework/request/unprocessable"
}

Headers

traceparent

string

W3C trace context.