Containers
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}/containers HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "text",
"name": "text",
"services": [
{
"slug": "text",
"name": "text",
"status": "ok"
}
],
"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)
Service membership is managed automatically — when a container is created, every existing service on the status page is assigned to it (full N×M grid). There is no API to assign or remove services individually; per-container service status is updated via notice updates.
Optional URL-safe identifier. If omitted, it is auto-generated from name.
If a non-unique value is provided, a numeric suffix is appended (e.g. eu-1).
Created
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
POST /api/v1/status_pages/{subdomain}/containers HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"name": "text",
"slug": "text"
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "text",
"name": "text",
"services": [
{
"slug": "text",
"name": "text",
"status": "ok"
}
],
"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)
Container slug (auto-generated from name)
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}/containers/{container_slug} HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "text",
"name": "text",
"services": [
{
"slug": "text",
"name": "text",
"status": "ok"
}
],
"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)
Container slug (auto-generated from name)
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}/containers/{container_slug} 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)
Container slug (auto-generated from name)
Service membership is not editable via this endpoint.
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}/containers/{container_slug} HTTP/1.1
Host: next.statuspal.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "text",
"name": "text",
"services": [
{
"slug": "text",
"name": "text",
"status": "ok"
}
],
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
}Last updated