Platform status roll-up

GET

/v1/status

const url = 'https://example.com/v1/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/status

Public status of the Protoface platform. Polled by the status page and operator dashboards. Unauthenticated.

Responses

200

Successful Response

application/json

StatusResponse

GET /v1/status response.

object

components

required

Array<object>

StatusComponent

object

name

required

string

status

required

string

Allowed values: operational degraded outage

status

required

Roll-up of all components.

string

Allowed values: operational degraded outage

updated_at

required

string format: date-time

Example

{
  "components": [
    {
      "status": "operational"
    }
  ],
  "status": "operational"
}