Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
List every status page in a project
GET /api/projects/{projectId}/status-pages
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your API key (Authorization: Bearer {jwt} also works). Read-only keys are fine. |
X-Project-ID | Yes | Must be the same project UUID as in the URL. |
| Parameter | Type | Description |
|---|---|---|
projectId | UUID | The project |
{
"success": true,
"data": {
"status_pages": [
{
"id": "0b7c3a52-7d57-4c35-9f0e-5a3b6f1f2a10",
"organization_id": "4f6f7b0e-1a52-4d7f-8d7e-6c5b1d2e3f40",
"project_id": "6ba7b810-9dad-41d1-80b4-00c04fd430c8",
"name": "Production Status",
"description": "Live status of production services",
"subdomain": "acme-production",
"status": "published",
"is_public": true,
"color_scheme": "light",
"logo_url": null,
"favicon_url": null,
"custom_css": null,
"component_display_order": "custom",
"show_uptime_percentage": true,
"show_response_time": true,
"timezone": "UTC",
"allow_search_indexing": true,
"uptime_timeframes": ["24h", "7d", "30d", "90d"],
"uptime_thresholds": { "operational": 99.9, "degraded": 95 },
"incident_history_days": 7,
"maintenance_affects_uptime": false,
"google_analytics_id": null,
"custom_domain": null,
"custom_domain_verified": false,
"ssl_enabled": false,
"ssl_certificate_status": null,
"auto_publish_enabled": true,
"auto_publish_severities": ["critical", "major"],
"subscriber_count": 245,
"monitor_count": 1,
"page_views_24h": 0,
"page_views_7d": 150,
"page_views_30d": 0,
"last_published_at": 1790000000000,
"created_by": null,
"created_at": 1790000000000,
"updated_at": 1790000000000,
"uptime_percentage": 99.9,
"monitors": [
{
"id": "a3f1c2d4-5b6e-4f70-8a91-b2c3d4e5f607",
"status_page_id": "0b7c3a52-7d57-4c35-9f0e-5a3b6f1f2a10",
"monitor_id": "a3f1c2d4-5b6e-4f70-8a91-b2c3d4e5f607",
"display_name": "API",
"group_name": "Core",
"display_order": 0,
"is_visible": true,
"show_uptime": true,
"show_response_time": true,
"created_at": 1790000000000,
"monitor_name": "API health check",
"monitor_url": "https://api.example.com/health",
"monitor_status": "up",
"current_uptime": 99.95,
"average_response_time": 145
}
],
"branding": { "defaultTheme": "light", "primaryColor": "#3B82F6" }
}
]
}
}
page_views_24h and page_views_30d are always 0 in the list. Use Get Status Page for those figures.monitors, uptime_percentage and branding are omitted when a page has no monitors or no branding.| Status | Code | Cause |
|---|---|---|
| 400 | PROJECT_ID_REQUIRED / INVALID_PROJECT_ID | X-Project-ID header missing or not a UUID |
| 401 | AUTHENTICATION_REQUIRED | Missing or invalid credentials |
| 403 | ACCESS_DENIED | No access to this project |
| 403 | API_KEY_ORGANIZATION_MISMATCH | The API key belongs to a different organization than the project |
curl https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages \
-H "X-API-Key: YOUR_API_KEY" \
-H "X-Project-ID: YOUR_PROJECT_ID"
const projectId = 'YOUR_PROJECT_ID';
const response = await fetch(
`https://api.uptimeio.com/api/projects/${projectId}/status-pages`,
{
headers: {
'X-API-Key': process.env.UPTIMEIO_API_KEY,
'X-Project-ID': projectId,
},
}
);
const { data } = await response.json();
for (const page of data.status_pages) {
console.log(page.name, page.status);
}
Was this page helpful?