Skip to main content

Infra Status

Arkhia's status API service allows end users to fetch the current status of the Arkhia services. The key goal of the status API is to inform you regarding any scheduled maintenance periods.

note

The Status API has a rate limit of 1 request per 30 seconds. We recommend polling the endpoint at a set interval of 30 seconds or more.

info

Arkhia status API is available only for Starter tiers and above.

You will need:

  • Arkhia's API Key Can be retrieved from your Arkhia Dashboard after you Create a Project.

Fetching Arkhia Status​

const axios = require('axios');let config = {  method: 'get',  url: 'https://api.arkhia.io/service/status/<YOUR_API_KEY>',};axios.request(config).then((response) => {  console.log(JSON.stringify(response.data));}).catch((error) => {  console.log(error);});

Response Objects​

  • Arkhia services are working as expected, the expected API response:

    Status Code: 200

    {    maintenance_mode: false //boolean    outage_mode: false //boolean}

  • Arkhia services are undergoing a scheduled maintenance, the expected API response:

    Status Code: 503

    {    maintenance_mode: true, //boolean    date_start: MAINTENANCE_START_TIMESTAMP, //string    date_end: MAINTENANCE_END_TIMESTAMP, //string    outage_mode: false //boolean}

  • Arkhia services are undergoing an unexpected outage, the expected API response:

    Status Code: 503

    {    maintenance_mode: false, //boolean    outage_mode: true //boolean    outage_message: "A message explaining the current outage and the services effected" //string}

  • Your request gets rate limited, the expected API response:

    Status Code: 401

    {    status: false, //boolean    response: "You have reached the rate limit for Arkhia status API. Please wait 30 seconds between two requests",}