health.getHealth

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

Checks that the HTTP service can respond. It does not check business dependencies.

Responses

200

Success

application/json

object

status

required

string

Allowed values: ok

Example

{
  "status": "ok"
}

503

RequestFailed

application/json

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "RequestFailed",
  "category": "invalid"
}