Incidents
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
Used as a cursor for pagination.
Used as a cursor for pagination.
Set the number of incidents to return in the response. This defaults to 20 items, and can be a maximum of 100.
Filter incidents by incident type key.
majorThe list of incidents
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/incidents HTTP/1.1
Host: statuspal.io
Accept: */*
{
"incidents": [
{
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"description_html": "<p>We have detected an issue with our CDN</p>",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"subscribers_notified_at": "2022-01-01T00:00:00",
"tweet": true
}
],
"url": "https://status.google.com/incidents/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
},
"affects_uptime": true
}
],
"links": {
"next": "{STATUSPAL_HOST}/api/v2/status_pages/subdomain/incidents?after=cUrSoR",
"prev": "text"
},
"meta": {
"total_count": 100
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The incident was created
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
There was a validation error
Unexpected error.
POST /api/v2/status_pages/{subdomain}/incidents HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 658
{
"incident": {
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"notify": true,
"tweet": true
}
],
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
}
}
}{
"incident": {
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"description_html": "<p>We have detected an issue with our CDN</p>",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"subscribers_notified_at": "2022-01-01T00:00:00",
"tweet": true
}
],
"url": "https://status.google.com/incidents/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
},
"affects_uptime": true
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of an incident/maintenance
Incident object
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/incidents/{incidentId} HTTP/1.1
Host: statuspal.io
Accept: */*
{
"incident": {
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"description_html": "<p>We have detected an issue with our CDN</p>",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"subscribers_notified_at": "2022-01-01T00:00:00",
"tweet": true
}
],
"url": "https://status.google.com/incidents/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
},
"affects_uptime": true
}
}The ID of an incident/maintenance
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The incident was updated
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
PUT /api/v2/status_pages/{subdomain}/incidents/{incidentId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 658
{
"incident": {
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"notify": true,
"tweet": true
}
],
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
}
}
}{
"incident": {
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"title": "We are having issues with the DB connection",
"starts_at": "2022-01-01T00:00:00",
"ends_at": "2022-01-01T00:00:00",
"type": "major",
"service_ids": [
1
],
"updates": [
{
"id": 89,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"posted_at": "2022-01-01T00:00:00",
"type": "issue",
"description": "We have detected an issue with our CDN",
"description_html": "<p>We have detected an issue with our CDN</p>",
"translations": {
"en": {
"description": "English description"
},
"es": {
"description": "Spanish description"
}
},
"subscribers_notified_at": "2022-01-01T00:00:00",
"tweet": true
}
],
"url": "https://status.google.com/incidents/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
},
"notify": true,
"maintenance_notify": true,
"maintenance_notify_settings": {
"before_notice_minutes": 7200,
"second_before_notice_minutes": 0,
"on_start": true,
"on_end": true
},
"affects_uptime": true
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of an incident/maintenance
Incident deleted successfully
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
DELETE /api/v2/status_pages/{subdomain}/incidents/{incidentId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated