AnkraDocs
Console

API reference · Account and billing

Service status

1 operation of the Ankra Cloud API: The public status page: incidents and maintenance windows staff publish from the staff console, each with the zones and services it touches and a timeline of updates, and the public feed the status page at ankra.cloud/status is drawn from.

How Ankra Cloud's services are doing, with open incidents, maintenance and recent history#

GET/v1/status
Operation
get_service_status
Credentials
None (public)

What the public status page shows. status is the worst status of any service anywhere. platform lists the services that are not tied to a zone (the API and consoles, DNS) and zones every zone customers can use with its services; each service is operational unless an open incident or a maintenance that has started names it, and then carries that event's impact (the worst one when several do). active holds open incidents and maintenance in progress, upcoming maintenance that has not started (soonest first) and history what was closed in the last 30 days (newest first, at most 50). A maintenance is in_progress from its starts_at on, whether or not staff marked it started, until staff complete or cancel it. Needs no credential. The answer is held for a few seconds, so a change staff make shows within about ten seconds.

Responses

200The current status.application/json · ServiceStatusReport

200 response fields
FieldTypeDescription
generated_atrequiredstring (date-time)
statusrequiredstringThe worst status of any service anywhere.One of operational, maintenance, degraded, partial_outage, major_outage
platformrequiredarray of ComponentStatusThe services that are not tied to a zone.
componentrequiredstringThe service: api (the API and the consoles) and dns are not tied to a zone; the others are a zone's servers, block storage, networking, load balancers, managed databases, managed Kubernetes and object storage.One of api, dns, servers, block_storage, networking, load_balancers, databases, kubernetes, object_storage
statusrequiredstringFrom best to worst; maintenance is a planned window in progress.One of operational, maintenance, degraded, partial_outage, major_outage
zonesrequiredarray of ZoneServiceStatus
namerequiredstring
display_namerequiredstring
regionrequiredstring
countryrequiredstringISO 3166-1 alpha-2, upper case.
statusrequiredstringThe worst status of the zone's services.One of operational, maintenance, degraded, partial_outage, major_outage
componentsrequiredarray of ComponentStatus
componentrequiredstringThe service: api (the API and the consoles) and dns are not tied to a zone; the others are a zone's servers, block storage, networking, load balancers, managed databases, managed Kubernetes and object storage.One of api, dns, servers, block_storage, networking, load_balancers, databases, kubernetes, object_storage
statusrequiredstringFrom best to worst; maintenance is a planned window in progress.One of operational, maintenance, degraded, partial_outage, major_outage
activerequiredarray of PublicStatusEventOpen incidents and maintenance in progress.
idrequiredstring
kindrequiredstringOne of incident, maintenance
titlerequiredstring
impactrequiredstringHow the named services are affected while the event is going on; always maintenance for a maintenance.One of maintenance, degraded, partial_outage, major_outage
staterequiredstringOne of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
zonesrequiredarray of stringThe zones it touches; empty means every zone.
componentsrequiredarray of stringOne of api, dns, servers, block_storage, networking, load_balancers, databases, kubernetes, object_storage
starts_atrequiredstring (date-time)When the incident began, or the maintenance window opens.
ends_atrequiredstring (date-time) | nullWhen the maintenance window is planned to close; null for an incident.
closed_atrequiredstring (date-time) | nullWhen it was resolved, completed or cancelled; null while it is open.
updatesrequiredarray of PublicStatusEventUpdateNewest first.
staterequiredstringThe state the update put the event in.One of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
messagerequiredstring
created_atrequiredstring (date-time)
upcomingrequiredarray of PublicStatusEventMaintenance that has not started, soonest first.
idrequiredstring
kindrequiredstringOne of incident, maintenance
titlerequiredstring
impactrequiredstringHow the named services are affected while the event is going on; always maintenance for a maintenance.One of maintenance, degraded, partial_outage, major_outage
staterequiredstringOne of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
zonesrequiredarray of stringThe zones it touches; empty means every zone.
componentsrequiredarray of stringOne of api, dns, servers, block_storage, networking, load_balancers, databases, kubernetes, object_storage
starts_atrequiredstring (date-time)When the incident began, or the maintenance window opens.
ends_atrequiredstring (date-time) | nullWhen the maintenance window is planned to close; null for an incident.
closed_atrequiredstring (date-time) | nullWhen it was resolved, completed or cancelled; null while it is open.
updatesrequiredarray of PublicStatusEventUpdateNewest first.
staterequiredstringThe state the update put the event in.One of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
messagerequiredstring
created_atrequiredstring (date-time)
historyrequiredarray of PublicStatusEventWhat was closed in the last 30 days, newest first, at most 50.
idrequiredstring
kindrequiredstringOne of incident, maintenance
titlerequiredstring
impactrequiredstringHow the named services are affected while the event is going on; always maintenance for a maintenance.One of maintenance, degraded, partial_outage, major_outage
staterequiredstringOne of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
zonesrequiredarray of stringThe zones it touches; empty means every zone.
componentsrequiredarray of stringOne of api, dns, servers, block_storage, networking, load_balancers, databases, kubernetes, object_storage
starts_atrequiredstring (date-time)When the incident began, or the maintenance window opens.
ends_atrequiredstring (date-time) | nullWhen the maintenance window is planned to close; null for an incident.
closed_atrequiredstring (date-time) | nullWhen it was resolved, completed or cancelled; null while it is open.
updatesrequiredarray of PublicStatusEventUpdateNewest first.
staterequiredstringThe state the update put the event in.One of investigating, identified, monitoring, resolved, scheduled, in_progress, completed, cancelled
messagerequiredstring
created_atrequiredstring (date-time)
  • defaultAny other error, usually 500.

Example

bash
curl 'https://cloud.ankra.app/v1/status'