Client API: Notices
Every Client API operation tagged Notices.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Client API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/notices |
The notices the account's dashboard shows now |
| GET | /api/v1/status |
The platform's status, for the public status page |
The notices the account's dashboard shows now
Section titled The notices the account's dashboard shows nowGET /api/v1/notices
The notices the account's dashboard shows now.
Announcements, planned maintenance and incidents that coritan.com's staff
published for the dashboard, live now and meant for this account: notices
for everyone, plus those for paying accounts when the account has an
active paid service or Pro or Business, or those for free accounts when it has
neither. Incidents come first, then maintenance, then announcements, at
most ten. Answers {"items": [...]}, each item with id, kind,
title, body, audience, placement, status,
starts_at, ends_at, resolved_at, created_at,
updated_at and updates (the timeline, newest first).
Authentication: an access token, sent as Authorization: Bearer <token>.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
The platform's status, for the public status page
Section titled The platform's status, for the public status pageGET /api/v1/status
The platform's status, for the public status page. No sign-in.
The overall state, each location and each public host with its load,
as the brands' status pages show it, plus incidents: the incidents
and planned maintenance coritan.com's staff published for the status
page, live now or resolved within the last 24 hours, each with its
timeline, and services: the website, the API and the payment
providers the storefront depends on, each operational, degraded,
down or unknown. A probe that cannot run says unknown.
Each host in nodes has queued_starts: the number of servers
waiting in that host's start queue when more than three are waiting, and
null otherwise.
status is the state of the locations, which are the hosts that run
customers' servers. Each email region is in mail with a state of its
own, and an email problem does not change status. unmonitored
lists the products this answer reports no live state for, each as
{key, name}: Object Storage, DNS and DDoS Shield.
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |