Check that the API is up

GET

/v1/health

Public, no token

Answers 200 with data.status ok whenever the service is running. It needs no token and is not counted against your account’s rate limit, so it is the first call to make against an environment.

It says only that the service answers: it checks nothing the other operations depend on, so one of them can still fail while this answers ok.

Responses

200 OK

Success: message is "Request completed successfully.".

Body

successbooleanrequired
Always true on a success.
one oftrue
messagestringrequired
exampleRequest completed successfully.
dataobject · HealthResponserequired
The service is up.
1 field of data
- statusstringrequired
  Always ok: the service is running and answering. It says nothing about any particular operation.
  one ofok

Example

{
  "success": true,
  "message": "Request completed successfully.",
  "data": {
    "status": "ok"
  }
}

Example request

curl -sS 'https://api.main-team.org/v1/health'

const res = await fetch('https://api.main-team.org/v1/health');
const body = await res.json();
if (!res.ok) throw new Error(`${res.status} ${body.error.code}: ${body.error.message}`);
console.log(body.data);

<?php
$ch = curl_init('https://api.main-team.org/v1/health');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$body = json_decode($response, true);
if ($status >= 400) {
    $error = $body['error'];
    throw new RuntimeException("$status {$error['code']}: {$error['message']}");
}
print_r($body['data']);