Services
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 list of Services
Authorization information is missing or invalid.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/services HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"services": [
{
"id": 1,
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"current_incident_type": "major",
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"inbound_email_address": "text",
"incoming_webhook_url": "text",
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"is_up": true,
"pause_monitoring_during_maintenances": true,
"inbound_email_id": "text",
"auto_incident": true,
"auto_notify": true,
"children_ids": [
1
],
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
],
"links": {
"next": "text",
"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 service was created
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.
POST /api/v2/status_pages/{subdomain}/services HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 836
{
"service": {
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"pause_monitoring_during_maintenances": true,
"auto_incident": true,
"auto_notify": true,
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [
1
],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
}{
"service": {
"id": 1,
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"current_incident_type": "major",
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"inbound_email_address": "text",
"incoming_webhook_url": "text",
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"is_up": true,
"pause_monitoring_during_maintenances": true,
"inbound_email_id": "text",
"auto_incident": true,
"auto_notify": true,
"children_ids": [
1
],
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
}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 a service
The service
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.
GET /api/v2/status_pages/{subdomain}/services/{serviceId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"service": {
"id": 1,
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"current_incident_type": "major",
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"inbound_email_address": "text",
"incoming_webhook_url": "text",
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"is_up": true,
"pause_monitoring_during_maintenances": true,
"inbound_email_id": "text",
"auto_incident": true,
"auto_notify": true,
"children_ids": [
1
],
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
}The ID of a service
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 service 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}/services/{serviceId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 836
{
"service": {
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"pause_monitoring_during_maintenances": true,
"auto_incident": true,
"auto_notify": true,
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [
1
],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
}{
"service": {
"id": 1,
"name": "Monitoring service",
"description": "Some description",
"private_description": "Some private description",
"parent_id": 1,
"current_incident_type": "major",
"monitoring": null,
"webhook_monitoring_service": "status-cake",
"webhook_custom_jsonpath_settings": {
"jsonpath": "$.status",
"expected_result": "\"up\""
},
"inbound_email_address": "text",
"incoming_webhook_url": "text",
"ping_url": "text",
"incident_type": "major",
"parent_incident_type": "major",
"is_up": true,
"pause_monitoring_during_maintenances": true,
"inbound_email_id": "text",
"auto_incident": true,
"auto_notify": true,
"children_ids": [
1
],
"translations": {
"en": {
"name": "English Name",
"description": "English description"
},
"es": {
"name": "Spanish Name",
"description": "Spanish description"
}
},
"private": true,
"display_uptime_graph": true,
"display_response_time_chart": true,
"order": 1,
"notification_recipients": [],
"monitoring_options": {
"method": "HEAD",
"headers": [
{
"key": "accept-language",
"value": "en"
}
],
"keyword_down": "down",
"keyword_up": "up"
}
}
}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 a service
Service 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}/services/{serviceId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated