Summary
Get the summary of a status page (status, services and active incidents and maintenances)
get/status_pages/{subdomain}/summary
Path parameters
subdomainstringRequired
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).
Responses
200
A status page's status
application/json
Represents the status summary of a status page
current_status_typestring · enum · nullableOptionalExample:
The current status type of the status page
majorPossible values: 403
You lack the necessary permissions to access this resource.
application/json
404
A resource with the provided ID was not found.
application/json
500
Unexpected error.
application/json
get/status_pages/{subdomain}/summary
GET /api/v2/status_pages/{subdomain}/summary HTTP/1.1
Host: statuspal.io
Accept: */*
{
"status_page": {
"url": "google.com",
"time_zone": "Etc/UTC",
"subdomain": "google",
"name": "Google",
"current_incident_type": "major"
},
"services": [
{
"name": "Monitoring service",
"id": 1,
"current_incident_type": "major",
"children": [
{
"name": "Monitoring service",
"id": 1,
"current_incident_type": "major",
"children": "[Circular Reference]"
}
]
}
],
"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
}
],
"maintenances": [
{
"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": "scheduled",
"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
}
],
"upcoming_maintenances": [
{
"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": "scheduled",
"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
}
],
"info_notices": [
{
"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",
"featured_from": "2022-01-01T00:00:00",
"featured_until": "2022-01-01T00:00:00",
"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/info_notices/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
}
}
],
"current_status_type": "major"
}Get the summary of a service (status, services and active incidents and maintenances)
get/status_pages/{subdomain}/services/{serviceId}/summary
Path parameters
subdomainstringRequired
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).
serviceIdintegerRequired
The ID of a service
Responses
200
A service's status
application/json
current_status_typestring · enum · nullableOptionalExample:
The current status type of the status page
majorPossible values: 403
You lack the necessary permissions to access this resource.
application/json
404
A resource with the provided ID was not found.
application/json
500
Unexpected error.
application/json
get/status_pages/{subdomain}/services/{serviceId}/summary
GET /api/v2/status_pages/{subdomain}/services/{serviceId}/summary HTTP/1.1
Host: statuspal.io
Accept: */*
{
"service": {
"name": "Monitoring service",
"id": 1,
"current_incident_type": "major",
"children": [
{
"name": "Monitoring service",
"id": 1,
"current_incident_type": "major",
"children": [
"[Circular Reference]"
]
}
]
},
"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
}
],
"maintenances": [
{
"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": "scheduled",
"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
}
],
"upcoming_maintenances": [
{
"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": "scheduled",
"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
}
],
"info_notices": [
{
"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",
"featured_from": "2022-01-01T00:00:00",
"featured_until": "2022-01-01T00:00:00",
"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/info_notices/123",
"translations": {
"en": {
"title": "English Title"
},
"es": {
"title": "Spanish Title"
}
}
}
],
"current_status_type": "major"
}Last updated