Status Pages
Custom Domains
Setup flow
curl -X PUT \
https://statuspal.eu/api/v2/orgs/{organizationId}/status_pages/{subdomain} \
-H 'Authorization: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{
"status_page": {
"domain_config": {
"provider": "cloudflare",
"domain": "status.example.com"
}
}
}'Removing a custom domain
Retrying a failed configuration
Changing the domain
Domain status values
The ID of the organization
The list of Status Pages
Authorization information is missing or invalid.
Unexpected error.
GET /api/v2/orgs/{organizationId}/status_pages HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"status_pages": [
{
"organization_id": 1,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com",
"previous_domain": "previous.your-company.com",
"status": "active",
"validation_records": {
"hostname_cname_name": "status.your-company.com",
"hostname_cname_value": "domains.statuspal.io",
"certificate_txt_name": "_acme-challenge.status.your-company.com",
"certificate_txt_value": "ds1B5ODRiFY2qta4wt26bmYahZyTz32Hbgg31EDv6Ao",
"hostname_txt_name": "_cf-custom-hostname.status.your-company.com",
"hostname_txt_value": "b2afffc5-d532-42d9-b396-e141d889646b"
},
"external_id": "fd3416ee-091b-4c0e-ad44-8ed5cda22599",
"error": "Certificate verification errors from Cloudflare: <b>Certificate is not active (TXT).</b>"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"logo": null,
"bg_image": null,
"favicon": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
],
"links": {
"next": "text",
"prev": "text"
},
"meta": {
"total_count": 100
}
}The ID of the organization
The Status Page 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.
Unexpected error.
POST /api/v2/orgs/{organizationId}/status_pages HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2282
{
"status_page": {
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
}{
"status_page": {
"organization_id": 1,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com",
"previous_domain": "previous.your-company.com",
"status": "active",
"validation_records": {
"hostname_cname_name": "status.your-company.com",
"hostname_cname_value": "domains.statuspal.io",
"certificate_txt_name": "_acme-challenge.status.your-company.com",
"certificate_txt_value": "ds1B5ODRiFY2qta4wt26bmYahZyTz32Hbgg31EDv6Ao",
"hostname_txt_name": "_cf-custom-hostname.status.your-company.com",
"hostname_txt_value": "b2afffc5-d532-42d9-b396-e141d889646b"
},
"external_id": "fd3416ee-091b-4c0e-ad44-8ed5cda22599",
"error": "Certificate verification errors from Cloudflare: <b>Certificate is not active (TXT).</b>"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"logo": null,
"bg_image": null,
"favicon": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
}The ID of the organization
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 Status Page
Authorization information is missing or invalid.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/orgs/{organizationId}/status_pages/{subdomain} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"status_page": {
"organization_id": 1,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com",
"previous_domain": "previous.your-company.com",
"status": "active",
"validation_records": {
"hostname_cname_name": "status.your-company.com",
"hostname_cname_value": "domains.statuspal.io",
"certificate_txt_name": "_acme-challenge.status.your-company.com",
"certificate_txt_value": "ds1B5ODRiFY2qta4wt26bmYahZyTz32Hbgg31EDv6Ao",
"hostname_txt_name": "_cf-custom-hostname.status.your-company.com",
"hostname_txt_value": "b2afffc5-d532-42d9-b396-e141d889646b"
},
"external_id": "fd3416ee-091b-4c0e-ad44-8ed5cda22599",
"error": "Certificate verification errors from Cloudflare: <b>Certificate is not active (TXT).</b>"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"logo": null,
"bg_image": null,
"favicon": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
}The ID of the organization
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 Status Page 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.
Unexpected error.
PUT /api/v2/orgs/{organizationId}/status_pages/{subdomain} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2282
{
"status_page": {
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
}{
"status_page": {
"organization_id": 1,
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"name": "Acme",
"url": "acme.com",
"time_zone": "Etc/UTC",
"subdomain": "acme-com",
"support_email": "support@acme.com",
"twitter_public_screen_name": null,
"about": null,
"display_about": true,
"domain_config": {
"provider": "cloudflare",
"domain": "status.your-company.com",
"previous_domain": "previous.your-company.com",
"status": "active",
"validation_records": {
"hostname_cname_name": "status.your-company.com",
"hostname_cname_value": "domains.statuspal.io",
"certificate_txt_name": "_acme-challenge.status.your-company.com",
"certificate_txt_value": "ds1B5ODRiFY2qta4wt26bmYahZyTz32Hbgg31EDv6Ao",
"hostname_txt_name": "_cf-custom-hostname.status.your-company.com",
"hostname_txt_value": "b2afffc5-d532-42d9-b396-e141d889646b"
},
"external_id": "fd3416ee-091b-4c0e-ad44-8ed5cda22599",
"error": "Certificate verification errors from Cloudflare: <b>Certificate is not active (TXT).</b>"
},
"restricted_ips": null,
"member_restricted": false,
"scheduled_maintenance_days": 7,
"custom_js": null,
"head_code": null,
"date_format": null,
"time_format": null,
"date_format_enforce_everywhere": false,
"display_calendar": true,
"hide_watermark": false,
"minor_notification_hours": 6,
"major_notification_hours": 3,
"maintenance_notification_hours": 6,
"history_limit_days": null,
"custom_incident_types_enabled": false,
"info_notices_enabled": true,
"locked_when_maintenance": false,
"noindex": false,
"enable_auto_translations": false,
"captcha_enabled": true,
"enable_embedding": true,
"strict_csp": true,
"translations": {
"en": {
"public_company_name": "Your company",
"header_logo_text": "Your company status page"
},
"es": {
"public_company_name": "Votre entreprise",
"header_logo_text": "Page d'état de votre entreprise"
}
},
"header_logo_text": "Status Page Name Status",
"public_company_name": null,
"logo": null,
"bg_image": null,
"favicon": null,
"display_uptime_graph": true,
"uptime_graph_days": 90,
"current_incidents_position": "below_services",
"theme_selected": "default",
"theme_configs": null,
"link_color": "0c91c3",
"header_bg_color1": "009688",
"header_bg_color2": "0c91c3",
"header_fg_color": "ffffff",
"incident_header_color": "009688",
"incident_link_color": null,
"status_ok_color": "48CBA5",
"status_minor_color": "FFA500",
"status_major_color": "e75a53",
"status_maintenance_color": "5378c1",
"custom_css": null,
"custom_header": null,
"custom_footer": null,
"notify_by_default": false,
"tweet_by_default": false,
"slack_subscriptions_enabled": null,
"discord_notifications_enabled": false,
"teams_notifications_enabled": false,
"google_chat_notifications_enabled": false,
"mattermost_notifications_enabled": false,
"sms_notifications_enabled": null,
"feed_enabled": true,
"calendar_enabled": false,
"google_calendar_enabled": false,
"subscribers_enabled": true,
"notification_email": null,
"reply_to_email": null,
"tweeting_enabled": true,
"email_layout_template": null,
"email_confirmation_template": null,
"email_notification_template": null,
"email_templates_enabled": null,
"allowed_email_domains": "acme.corp\\nnapster.com",
"zoom_notifications_enabled": false
}
}The ID of the organization
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 Status Page was deleted
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/orgs/{organizationId}/status_pages/{subdomain} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated