Liveness and contract version

GET

/health

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

Unauthenticated. contract is the hash-locked contract version this deployment was built against — the one number worth comparing when a client and the API disagree about a shape.

Responses

200

The deployment is up.

application/json

object

required

boolean

service

required

string

Allowed values: sloose-api

environment

required

string

Allowed values: development staging production

contract

required

string

Example

{
  "ok": true,
  "service": "sloose-api",
  "environment": "development"
}