Service statusFree
https://api.aussieoutagetracker.com.au/v1/statusPublic: no key needed, never billed.
Whether the API is up, how fresh the data is, and for each network whether its feed can be read and whether what it sends passes our checks. No key needed and never billed, so a status page or a monitor can poll it. Cached for 30 seconds; polling faster returns the same answer.
Takes no parameters.
Responses
200Success
apienumdegraded when the API could not read the archive just now; networks is then the last known answer, or empty.
okdegradeddata_as_ofstring (date-time)nullableWhen the most recent successful poll of any network finished.
generated_atstring (date-time)When this answer was computed. It is cached for up to 30 seconds.
networksarray of objectShowHide 6 fields of each item
idstringThe network id, as in GET /v1/networks.
namestringstatesarray of enumnswvicqldsawatasntactfeed_statusenumWhether we can see the network: ok, degraded (reporting, but at least one poll in ten failed over the last three hours, so restorations can arrive late and short outages can be missed), stale (no successful poll for three poll intervals), failing (three of the last five polls failed), unknown (never polled). The same verdict as the public map.
okdegradedstalefailingunknownlast_success_atstring (date-time)nullableWhen its feed was last read successfully.
contractenumWhether what the network is sending passes our checks, judged on its latest payload. ok: clean. warn: something worth knowing that does not make the data wrong — an unfamiliar status word, one odd record. error: a meaningful share of its current outages fail the checks, or records are being dropped. unknown: not yet checked.
okwarnerrorunknown400A parameter is invalid or unknown — error.param names it.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
429Over 60 requests a minute from one address.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
Errors lists every error code and what to do about it.