Status Pages
Manage status pages within your organization
Organization API key — issue one via the Rails console (management UI coming soon)
120OK
Missing or invalid API key
The account is pending activation. A newly created account must be activated by an administrator before its API key can be used.
GET /api/v1/status_pages HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subdomain": "acme-status",
"name": "Acme Status",
"timezone": "America/New_York",
"website_url": "https://acme.com",
"current_status": "operational",
"require_authentication": false,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
],
"meta": {
"current_page": 1,
"per_page": 1,
"total_count": 1,
"total_pages": 1
}
}Organization API key — issue one via the Rails console (management UI coming soon)
acme-statusPattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$Acme StatusAmerica/New_YorkfalseCreated
Missing or invalid API key
The account is pending activation. A newly created account must be activated by an administrator before its API key can be used.
Validation failed
POST /api/v1/status_pages HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 460
{
"subdomain": "acme-status",
"name": "Acme Status",
"timezone": "America/New_York",
"website_url": "https://example.com",
"require_authentication": false,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
},
"services": [
{
"name": "Payment gateway",
"slug": "pay-gw",
"containers": [
"eu",
"us"
]
},
{
"name": "API",
"description": "Public REST API",
"containers": [
"eu"
]
},
{
"name": "Webhooks"
}
],
"containers": [
{
"name": "EU",
"slug": "eu"
},
{
"name": "US"
}
]
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"subdomain": "acme-status",
"name": "Acme Status",
"timezone": "America/New_York",
"website_url": "https://acme.com",
"current_status": "operational",
"require_authentication": false,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
}Organization API key — issue one via the Rails console (management UI coming soon)
Status page subdomain (e.g. acme-status)
OK
Missing or invalid API key
The account is pending activation. A newly created account must be activated by an administrator before its API key can be used.
Resource not found
GET /api/v1/status_pages/{subdomain} HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"subdomain": "acme-status",
"name": "Acme Status",
"timezone": "America/New_York",
"website_url": "https://acme.com",
"current_status": "operational",
"require_authentication": false,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
}Organization API key — issue one via the Rails console (management UI coming soon)
Status page subdomain (e.g. acme-status)
Deleted
No content
Missing or invalid API key
The account is pending activation. A newly created account must be activated by an administrator before its API key can be used.
Resource not found
DELETE /api/v1/status_pages/{subdomain} HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Organization API key — issue one via the Rails console (management UI coming soon)
Status page subdomain (e.g. acme-status)
OK
Missing or invalid API key
The account is pending activation. A newly created account must be activated by an administrator before its API key can be used.
Resource not found
Validation failed
PATCH /api/v1/status_pages/{subdomain} HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191
{
"name": "text",
"timezone": "text",
"website_url": "https://example.com",
"require_authentication": true,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
}
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"subdomain": "acme-status",
"name": "Acme Status",
"timezone": "America/New_York",
"website_url": "https://acme.com",
"current_status": "operational",
"require_authentication": false,
"notification_settings": {
"email_enabled": true,
"slack_enabled": true,
"rss_feed_enabled": true
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
}Last updated