Docs

Start here

Platform status

GET/v1/statuson https://api.auray.ai/v1

Takes no key and charges nothing.

Takes no key and charges nothing. Every part of the platform with its state now and its uptime over the last thirty days, the incidents open now, the maintenance announced ahead, and what was resolved recently. If part of the answer cannot be read, the response says degraded_source: true and stays a 200 — a status endpoint that goes down with the platform cannot be told apart from a network problem of your own. Every incident carries the newest update published about it; announced maintenance is scheduled, never incidents, until its window begins, and says maintenance: true before and after; and resolved lists what ended recently, each with its final word. Cached at the edge for fifteen seconds with fifteen seconds of stale service.

#Authentication

No key needed — this document is public.

#Example request

curl https://api.auray.ai/v1/status

#Responses

#200 OK

OK. overall is the worst state any component is in.

FieldTypeRequiredDefaultDescription
overallstringno—One of "operational", "degraded", "down", "unknown".
degraded_sourcebooleanno—True when part of this answer could not be read. The rest of the body is still the best available and overall is unknown.
componentsobject[]no—
components[].idstringno—
components[].namestringno—
components[].statestringno—One of "operational", "degraded", "down", "unknown".
components[].sourcestringno—auto: from monitoring; operator: from an incident we posted; none: no current data. One of "auto", "operator", "none".
components[].monitoredbooleanno—Whether this component is monitored. One that is not reads unknown with source: none until we post something about it.
components[].measured_bynullno—Deprecated: always null, and removed in a later release.
components[].checked_atstringno—May be null.
components[].uptimeobjectno—Uptime over the last uptime_days days, or null when it could not be read. A day's figure is the share of that day's checks the component passed, lowered by any time an incident we posted marked it degraded or down; a day with no data is null. Every figure is a percent, truncated (never rounded) to three decimal places. May be null.
components[].uptime.percentnumberno—The window's figure, or null when no day in it has data. May be null.
components[].uptime.daysobject[]no—One entry per UTC day, oldest first; the last is today so far.
components[].uptime.days[].datestringno—
components[].uptime.days[].percentnumberno—That day's figure, or null when there is no data for it. May be null.
incidentsobject[]no—
incidents[].idstringno—
incidents[].titlestringno—
incidents[].statusstringno—One of "investigating", "identified", "monitoring", "resolved".
incidents[].impactstringno—One of "none", "minor", "major", "critical".
incidents[].componentsstring[]no—
incidents[].started_atstringno—When it began — for a maintenance window, when the window opens.
incidents[].resolved_atstringno—May be null.
incidents[].ends_atstringno—When a maintenance window, or the fix, is expected to end. Null when nobody has said. May be null.
incidents[].maintenancebooleanno—True for a maintenance window announced ahead, before it begins and after — its status says how far the work has got, not how far a fault's fix has.
incidents[].updateobjectno—The newest update published about it: what is known now, in the words of the person who wrote it. May be null.
incidents[].update.atstringno—
incidents[].update.statusstringno—One of "investigating", "identified", "monitoring", "resolved".
incidents[].update.bodystringno—
scheduledobject[]no—Maintenance announced ahead, whose window has not begun. It moves to incidents when it does.
scheduled[].idstringno—
scheduled[].titlestringno—
scheduled[].statusstringno—One of "investigating", "identified", "monitoring", "resolved".
scheduled[].impactstringno—One of "none", "minor", "major", "critical".
scheduled[].componentsstring[]no—
scheduled[].started_atstringno—When it began — for a maintenance window, when the window opens.
scheduled[].resolved_atstringno—May be null.
scheduled[].ends_atstringno—When a maintenance window, or the fix, is expected to end. Null when nobody has said. May be null.
scheduled[].maintenancebooleanno—True for a maintenance window announced ahead, before it begins and after — its status says how far the work has got, not how far a fault's fix has.
scheduled[].updateobjectno—The newest update published about it: what is known now, in the words of the person who wrote it. May be null.
scheduled[].update.atstringno—
scheduled[].update.statusstringno—One of "investigating", "identified", "monitoring", "resolved".
scheduled[].update.bodystringno—
resolvedobject[]no—Incidents resolved in the last resolved_history_days days, newest first, each with its final update.
resolved[].idstringno—
resolved[].titlestringno—
resolved[].statusstringno—One of "investigating", "identified", "monitoring", "resolved".
resolved[].impactstringno—One of "none", "minor", "major", "critical".
resolved[].componentsstring[]no—
resolved[].started_atstringno—When it began — for a maintenance window, when the window opens.
resolved[].resolved_atstringno—May be null.
resolved[].ends_atstringno—When a maintenance window, or the fix, is expected to end. Null when nobody has said. May be null.
resolved[].maintenancebooleanno—True for a maintenance window announced ahead, before it begins and after — its status says how far the work has got, not how far a fault's fix has.
resolved[].updateobjectno—The newest update published about it: what is known now, in the words of the person who wrote it. May be null.
resolved[].update.atstringno—
resolved[].update.statusstringno—One of "investigating", "identified", "monitoring", "resolved".
resolved[].update.bodystringno—
resolved_history_daysintegerno—How many days back resolved reaches. Zero means resolved is always empty; with a positive number, an empty resolved means nothing ended in that time.
uptime_daysintegerno—How many days each component's uptime covers: 30.
accepting_requestsbooleanno—Whether POST /v1/support/requests is taking anything right now: false while intake is closed, and while this deployment is not switched on or not configured to take requests.
announcementobjectno—What we are announcing on auray.ai now, in our words — a notice, an offer or a campaign — or null when there is nothing. An announcement about an offer or a campaign is listed only while that offer has a place left or that campaign is running, and every announcement has an end. An incident in incidents is more urgent than this, and the site's header says the incident first. May be null.
announcement.codestringno—Our label for the announcement.
announcement.plansstring[]no—Whom it is for: the plans the offer or campaign it is about covers, or empty for a notice that is everybody's. An offer is announced only to the plans it covers, and its words must name it.
announcement.headlineobjectno—One line, at most 90 characters, in English and Indonesian.
announcement.headline.enstringyes—
announcement.headline.idstringyes—Indonesian.
announcement.bodyobjectno—More, at most 400 characters, in both languages; null when the headline is all of it. May be null.
announcement.body.enstringyes—
announcement.body.idstringyes—Indonesian.
announcement.linkstringno—Where it points: a page on https://auray.ai, https://www.auray.ai or https://app.auray.ai, or a path on auray.ai. Null for none. May be null.
announcement.ends_atstringno—When it stops being announced.
checked_atstringno—

Headers:

HeaderDescription
Cache-Controlpublic, s-maxage=15, stale-while-revalidate=15.
X-Request-Id

#503 Service Unavailable

support_disabled — the support surface is closed, this page included. It is the one thing that stops this route answering.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
200OK. overall is the worst state any component is in.
503support_disabled — the support surface is closed, this page included.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close