Check the address

GET

/health

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

Answers without a key. Use it to see that the API is reachable.

Responses

200

The API is reachable.

application/json

object

required

boolean

service

required

string

version

required

integer

time

required

string format: date-time

Example

{
  "ok": true,
  "service": "Mayotte Hub API",
  "version": 1
}

429

Too many calls (rate). Wait for the retry-after header, in seconds.

application/json

object

error

required

Words for a person. They may change.

string

code

required

What your program should read.

string

Allowed values: bad_json bad_event no_key bad_key revoked expired no_timestamp old_timestamp no_signature bad_signature scope ip not_found method too_large rate server unreachable not_ready

Example

{
  "code": "bad_json"
}

Headers

retry-after

integer