Status Page API

The Status Page API provides public status-page endpoints for subscribers and integrations. Authenticated status-service customers also get management endpoints for their own status pages. All endpoints return JSON and use standard HTTP methods.

Base URL: https://statuspage.cloudsigma.com/api/v1

Authentication

Public status-page endpoints do not require authentication. Subscriber actions such as subscribe/unsubscribe use email verification tokens. Management endpoints require an authenticated status-service customer session or API key with appropriate scopes.

Option A — Bearer Token:
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx
Option B — API Key Header:
X-API-Key: sk_live_xxxxxxxxxxxxxxxx

Sign in as a status-service customer to view management API documentation and Swagger/ReDoc links.

Error Handling

All errors return a JSON object with a detail field:

StatusMeaning
400Bad Request — invalid parameters
401Unauthorized — missing or invalid API key
403Forbidden — insufficient permissions
404Not Found — resource doesn't exist
422Validation Error — check request body
500Server Error — try again or contact support

GET Global Status

/api/v1/status

Returns the overall system status with component counts by status category and active incident/maintenance counts. No authentication required.

Response Fields
FieldTypeDescription
statusstringOverall status: operational, degraded_performance, partial_outage, major_outage, under_maintenance
indicatorsobjectCount of components per status category
active_incidentsintegerNumber of unresolved incidents
scheduled_maintenanceintegerNumber of active maintenance windows
last_updatedstringISO 8601 timestamp
cURL
Python
JavaScript
# Get global status
curl https://statuspage.cloudsigma.com/api/v1/status
import requests

response = requests.get(
    "https://statuspage.cloudsigma.com/api/v1/status"
)
data = response.json()
print(data["status"])  # "operational"
const response = await fetch(
  "https://statuspage.cloudsigma.com/api/v1/status"
);
const data = await response.json();
console.log(data.status); // "operational"
Response · 200
{
  "status": "operational",
  "indicators": {
    "operational": 18,
    "degraded_performance": 0,
    "partial_outage": 0,
    "major_outage": 0,
    "under_maintenance": 0
  },
  "active_incidents": 0,
  "scheduled_maintenance": 1,
  "last_updated": "2026-02-28T06:30:00+00:00"
}

GET List Components

/api/v1/components

Returns all components (cloud locations, services, regions) with their current status. No authentication required.

Query Parameters
ParameterTypeDescription
status_filterstringFilter by status (e.g. OPERATIONAL)
pageintegerPage number (default: 1)
per_pageintegerResults per page (default: 100)
cURL
Python
JavaScript
# List all components
curl https://statuspage.cloudsigma.com/api/v1/components
import requests

response = requests.get(
    "https://statuspage.cloudsigma.com/api/v1/components"
)
components = response.json()
for c in components:
    print(f"{c['name']}: {c['status']}")
const response = await fetch(
  "https://statuspage.cloudsigma.com/api/v1/components"
);
const components = await response.json();
components.forEach(c =>
  console.log(`${c.name}: ${c.status}`)
);
Response · 200
[
  {
    "id": "a1b2c3d4-...",
    "name": "Zurich (ZRH)",
    "code": "zrh",
    "status": "operational",
    "description": "Zurich, Switzerland",
    "position": 1
  },
  ...
]