StatusPal logo
API docs by Redocly

StatusPal API Reference (2.0.0)

Download OpenAPI specification:

E-mail: contact@statuspal.io URL: https://www.statuspal.io

Welcome to the StatusPal API reference.


← Go back to StatusPal

Introduction

Here you'll learn how to leverage the power of StatusPal through its API to query your status page's status, create and update incidents, push custom metrics and more.

Servers

  • https://statuspal.io/api/v2 (US servers)
  • https://statuspal.eu/api/v2 (EU servers)

If you need some assistance please email us at support@statuspal.io.

Example request

curl https://statuspal.io/api/v2/hello \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

Datetimes

All datetime fields are stored in UTC and follow ISO 8601 standard (2022-01-01T00:00:00).

Authentication

Some endpoints require authentication in order to be used, you'll need to pass your API key in the Authorization header, you can find your API key in your User Account page or under your organization's "Security > API" Keys page.

api_key

Security Scheme Type: API Key
Header parameter name: Authorization

Example authenticated request:

curl -X POST \
  https://statuspal.io/api/v2/status_pages/:subdomain/incidents \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <your-api-key>' \
  -d '{
   "incident": {
      "type": "major",
      "title": "DB connection issues",
      "service_ids": [1],
      "updates": [{ "type": "issue", "description": "We investigating" }]
    }
  }'

Rate Limits

Our API has the following rate limits:

EU Region

300 requests per 10 seconds

US Region

100 requests per 10 seconds

What happens when the rate limit is exceeded?

If the rate limit is exceeded, the API will return a 429 status code.

Need a custom rate limit?

Please contact us at support@statuspal.io and we'll be happy to help you.

Test

Test endpoints

Says hello

Responses

Response samples

Content type
json
{
  • "message": "hello"
}

Status

Status endpoints

Get the status reported on a status page

path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "status_page": {
    }
}

Get the status reported on a status page service

path Parameters
subdomain
required
string

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).

serviceId
required
integer

The ID of a service

Responses

Response samples

Content type
json
{
  • "service": {
    }
}

Summary

Summary endpoints

Get the summary of a status page (status, services and active incidents and maintenances)

path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "status_page": {
    },
  • "services": [
    ],
  • "incidents": [
    ],
  • "maintenances": [
    ],
  • "upcoming_maintenances": [
    ],
  • "info_notices": [
    ],
  • "current_status_type": "major"
}

Get the summary of a service (status, services and active incidents and maintenances)

path Parameters
subdomain
required
string

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).

serviceId
required
integer

The ID of a service

Responses

Response samples

Content type
json
{
  • "service": {
    },
  • "incidents": [
    ],
  • "maintenances": [
    ],
  • "upcoming_maintenances": [
    ],
  • "info_notices": [
    ],
  • "current_status_type": "major"
}

Incidents

Incidents endpoints

Get the list of incidents of a status page

path Parameters
subdomain
required
string

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).

query Parameters
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of incidents to return in the response. This defaults to 20 items, and can be a maximum of 100.

type
string
Example: type=major

Filter incidents by incident type key.

Responses

Response samples

Content type
json
{
  • "incidents": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new incident associated to one or more services

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The incident

object (Incident)

An incident, either major, minor or a scheduled maintenance

Responses

Request samples

Content type
json
{
  • "incident": {
    }
}

Response samples

Content type
json
{
  • "incident": {
    }
}

Get an incident

path Parameters
subdomain
required
string

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).

incidentId
required
integer

The ID of an incident/maintenance

Responses

Response samples

Content type
json
{
  • "incident": {
    }
}

Updates existing incident

Authorizations:
api_key
path Parameters
incidentId
required
integer

The ID of an incident/maintenance

subdomain
required
string

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).

Request Body schema: json
required

The incident

object (Incident)

An incident, either major, minor or a scheduled maintenance

Responses

Request samples

Content type
json
{
  • "incident": {
    }
}

Response samples

Content type
json
{
  • "incident": {
    }
}

Deletes incident permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentId
required
integer

The ID of an incident/maintenance

Responses

Response samples

Content type
json
{
  • "error": 401
}

Incident Updates

Incident Updates endpoints

Adds a new update to the given incident

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentId
required
integer

The ID of an incident/maintenance

Request Body schema: json
required

The update

object (IncidentActivity)

Communicates an update of an incident, the special type resolved will close an incident.

Responses

Request samples

Content type
json
{
  • "update": {
    }
}

Response samples

Content type
json
{
  • "update": {
    }
}

Updates an incident update

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentId
required
integer

The ID of an incident/maintenance

updateId
required
integer
Request Body schema: json
required

The update

object (IncidentActivity)

Communicates an update of an incident, the special type resolved will close an incident.

Responses

Request samples

Content type
json
{
  • "update": {
    }
}

Response samples

Content type
json
{
  • "update": {
    }
}

Deletes incident update permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentId
required
integer

The ID of an incident/maintenance

updateId
required
integer

Responses

Response samples

Content type
json
{
  • "error": 401
}

Incident Templates

Incident Templates endpoints

Get the incident templates

path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "incident_templates": [
    ]
}

Adds a new incident template

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The incident template

object (IncidentTemplate)

Represents the incident template.

Responses

Request samples

Content type
json
{
  • "incident_template": {
    }
}

Response samples

Content type
json
{
  • "incident_template": {
    }
}

Get incident template against given incident template id

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentTemplateId
required
integer

The ID of an incident template

Responses

Response samples

Content type
json
{
  • "incident_template": {
    }
}

Deletes incident template permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

incidentTemplateId
required
integer

The ID of an incident template

Responses

Response samples

Content type
json
{
  • "error": 401
}

Updates existing incident template

Authorizations:
api_key
path Parameters
integrationId
required
integer

The ID of integration

incidentTemplateId
required
integer

The ID of an incident template

Request Body schema: json
required

The incident template

object (IncidentTemplate)

Represents the incident template.

Responses

Request samples

Content type
json
{
  • "incident_template": {
    }
}

Response samples

Content type
json
{
  • "incident_template": {
    }
}

Information Notices

Information Notices endpoints

Get the list of information notices of a status page

path Parameters
subdomain
required
string

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).

query Parameters
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of information notices to return in the response. This defaults to 20 items, and can be a maximum of 100.

Responses

Response samples

Content type
json
{
  • "info_notices": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new information notice associated to one or more services

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The information notice

object (InfoNotice)

An information notice

Responses

Request samples

Content type
json
{
  • "info_notice": {
    }
}

Response samples

Content type
json
{
  • "info_notice": {
    }
}

Get an information notice

path Parameters
subdomain
required
string

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).

infoNoticeId
required
integer

The ID of an information notice

Responses

Response samples

Content type
json
{
  • "info_notice": {
    }
}

Updates existing information notice

Authorizations:
api_key
path Parameters
infoNoticeId
required
integer

The ID of an information notice

subdomain
required
string

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).

Request Body schema: json
required

The information notice

object (InfoNotice)

An information notice

Responses

Request samples

Content type
json
{
  • "info_notice": {
    }
}

Response samples

Content type
json
{
  • "info_notice": {
    }
}

Deletes information notice permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

infoNoticeId
required
integer

The ID of an information notice

Responses

Response samples

Content type
json
{
  • "error": 401
}

Information Notice Updates

These endpoints are the same as Incident Updates endpoints, but it doesn't support the type attribute.

Metrics

Metrics endpoints

Get the metrics

path Parameters
subdomain
required
string

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).

query Parameters
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of metrics to return in the response. This defaults to 20 items, and can be a maximum of 100.

Responses

Response samples

Content type
json
{
  • "metrics": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new metric

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The metric

object (Metric)

Represents a metric object.

Responses

Request samples

Content type
json
{
  • "metric": {
    }
}

Response samples

Content type
json
{
  • "metric": {
    }
}

Get metric against given metric id

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

metricId
required
integer

The ID of a custom metric

Responses

Response samples

Content type
json
{
  • "metric": {
    }
}

Deletes metric permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

metricId
required
integer

The ID of a custom metric

Responses

Response samples

Content type
json
{
  • "error": 401
}

Updates existing metric

Authorizations:
api_key
path Parameters
metricId
required
integer

The ID of a custom metric

subdomain
required
string

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).

Request Body schema: json
required

The metric

object (Metric)

Represents a metric object.

Responses

Request samples

Content type
json
{
  • "metric": {
    }
}

Response samples

Content type
json
{
  • "metric": {
    }
}

Adds a metric data point to a custom metric

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

metricId
required
integer

The ID of a custom metric

Request Body schema: json
required

The metric entry

object (MetricEntry)

Responses

Request samples

Content type
json
{
  • "entry": {
    }
}

Response samples

Content type
json
{
  • "entry": {
    }
}

Integrations

Integrations endpoints

Get the integrations

path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "integrations": [
    ]
}

Adds a new integration

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The integration

object (Integration)

Represents an integration service.

Responses

Request samples

Content type
json
{
  • "integration": {
    }
}

Response samples

Content type
json
{
  • "integration": {
    }
}

Get integration against given integration id

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

integrationId
required
integer

The ID of integration

Responses

Response samples

Content type
json
{
  • "integration": {
    }
}

Deletes integration permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

integrationId
required
integer

The ID of integration

Responses

Response samples

Content type
json
{
  • "error": 401
}

Updates existing integration

Authorizations:
api_key
path Parameters
integrationId
required
integer

The ID of integration

subdomain
required
string

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).

Request Body schema: json
required

The integration

object (Integration)

Represents an integration service.

Responses

Request samples

Content type
json
{
  • "integration": {
    }
}

Response samples

Content type
json
{
  • "integration": {
    }
}

Status Pages

Manage your organization's status pages — create, update, delete, and configure custom domains.

Custom Domains

You can serve your status page on a custom domain (e.g. status.example.com) by configuring the domain_config object on a status page. StatusPal supports two CDN providers: Cloudflare and Bunny.

Setup flow

1. Enable the custom domain: Update the status page with domain_config.provider and domain_config.domain:

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"
      }
    }
  }'

StatusPal begins provisioning the domain asynchronously. The domain_config.status field starts as configuring.

2. Retrieve DNS records: Poll GET /orgs/{organizationId}/status_pages/{subdomain} until domain_config.validation_records is populated (typically a few seconds). The records you need depend on the provider:

Provider Records required
Cloudflare 1 CNAME (hostname_cname_name → hostname_cname_value), 1 TXT for hostname verification (hostname_txt_name / hostname_txt_value), and 1 TXT for SSL certificate (certificate_txt_name / certificate_txt_value)
Bunny 1 CNAME (hostname_cname_name → hostname_cname_value)

Note: For the Cloudflare provider, the certificate_txt_* fields may not appear immediately. Poll every 10–15 seconds until they are present.

Note: For the Bunny provider, the hostname_cname_value field may be empty on the initial response while the pull zone is being created. Poll every 2–5 seconds until it is populated (typically a few seconds).

3. Create DNS records: Add the records at your DNS provider. If your DNS provider is Cloudflare, make sure the CNAME has proxy disabled (DNS-only / grey cloud).

4. Wait for activation: Poll the status page until domain_config.status becomes active. This typically takes 1–10 minutes.

Removing a custom domain

Set domain_config.provider and domain_config.domain to null:

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": null,
        "domain": null
      }
    }
  }'

Retrying a failed configuration

If domain_config.status is failed_to_configure, re-submit the same domain_config to restart provisioning.

Changing the domain

Update domain_config.domain to the new value. StatusPal will revoke the old domain's certificate and begin provisioning the new one. Follow steps 2–4 again.

Domain status values

Status Meaning
disabled No custom domain configured.
configuring Provisioning in progress or waiting for DNS verification.
active Domain is live with SSL.
failed_to_configure Setup failed — check domain_config.error for details.

List status pages

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

Responses

Response samples

Content type
json
{
  • "status_pages": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new status page

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

Request Body schema: json

The status page

object (OrganizationStatusPage)

Represents the Status Page.

Responses

Request samples

Content type
json
{
  • "status_page": {
    }
}

Response samples

Content type
json
{
  • "status_page": {
    }
}

Get a status page

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

subdomain
required
string

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

Response samples

Content type
json
{
  • "status_page": {
    }
}

Updates a status page

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

subdomain
required
string

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).

Request Body schema: json

The status page

object (OrganizationStatusPage)

Represents the Status Page.

Responses

Request samples

Content type
json
{
  • "status_page": {
    }
}

Response samples

Content type
json
{
  • "status_page": {
    }
}

Deletes a status page permanently

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

subdomain
required
string

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

Response samples

Content type
json
{
  • "error": 401
}

Subscriptions

List subscriptions

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

query Parameters
filter
string

Filters by email address or phone number.

In order to search by phone number, the following is supported:

  1. Full phone number. Ensure the country code is prefixed by a + sign and include a space between the country code and phone number (e.g. +49 000000000 or +49 000 000 000)
  2. Country code (e.g. +49)
  3. Phone number without country code (e.g. 000000000)
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.

Responses

Response samples

Content type
json
{
  • "subscriptions": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new subscription email, SMS or discord subscription

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The subscription

object (Subscription)

Responses

Request samples

Content type
json
{
  • "subscription": {
    }
}

Response samples

Content type
json
{
  • "subscription": {
    }
}

Get a subscription

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

subscriptionId
required
string

The ID of a subscription

Responses

Response samples

Content type
json
{
  • "subscription": {
    }
}

Update the subscription

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

subscriptionId
required
string

The ID of a subscription

Request Body schema: json
required

The subscription

object (Subscription)

Responses

Request samples

Content type
json
{
  • "subscription": {
    }
}

Response samples

Content type
json
{
  • "subscription": {
    }
}

Deletes the subscription

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

subscriptionId
required
string

The ID of a subscription

Responses

Response samples

Content type
json
{
  • "error": 401
}

Services

List services

Authorizations:
api_key
path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "services": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new service

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The service

object (Service)

Represents the service.

Responses

Request samples

Content type
json
{
  • "service": {
    }
}

Response samples

Content type
json
{
  • "service": {
    }
}

Get a service

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

serviceId
required
integer

The ID of a service

Responses

Response samples

Content type
json
{
  • "service": {
    }
}

Updates existing service

Authorizations:
api_key
path Parameters
serviceId
required
integer

The ID of a service

subdomain
required
string

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).

Request Body schema: json
required

The service

object (Service)

Represents the service.

Responses

Request samples

Content type
json
{
  • "service": {
    }
}

Response samples

Content type
json
{
  • "service": {
    }
}

Deletes service permanently

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

serviceId
required
integer

The ID of a service

Responses

Response samples

Content type
json
{
  • "error": 401
}

Webhooks

List all webhooks

Authorizations:
api_key
path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "webhooks": [
    ]
}

Adds a new webhook

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The webhook

object (Webhook)

Responses

Request samples

Content type
json
{
  • "webhook": {
    }
}

Response samples

Content type
json
{
  • "webhook": {
    }
}

Get a webhook

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

webhookId
required
integer

The ID of a webhook

Responses

Response samples

Content type
json
{
  • "webhook": {
    }
}

Update the webhook

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

webhookId
required
integer

The ID of a webhook

Request Body schema: json
required

The webhook

object (Webhook)

Responses

Request samples

Content type
json
{
  • "webhook": {
    }
}

Response samples

Content type
json
{
  • "webhook": {
    }
}

Deletes the webhook

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

webhookId
required
integer

The ID of a webhook

Responses

Response samples

Content type
json
{
  • "error": 401
}

Access Groups

List all access groups

Authorizations:
api_key
path Parameters
subdomain
required
string

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

Response samples

Content type
json
{
  • "access_groups": [
    ]
}

Adds a new access group

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The access group

object (AccessGroup)

Responses

Request samples

Content type
json
{
  • "access_group": {
    }
}

Response samples

Content type
json
{
  • "access_group": {
    }
}

Get an access group

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

accessGroupId
required
integer

The ID of an access group

Responses

Response samples

Content type
json
{
  • "access_group": {
    }
}

Update the access group

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

accessGroupId
required
integer

The ID of an access group

Request Body schema: json
required

The access group

object (AccessGroup)

Responses

Request samples

Content type
json
{
  • "access_group": {
    }
}

Response samples

Content type
json
{
  • "access_group": {
    }
}

Deletes the access group

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

accessGroupId
required
integer

The ID of an access group

Responses

Response samples

Content type
json
{
  • "error": 401
}

Status Page Members

List all members

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

query Parameters
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.

email
string

Filter the members by email.

Responses

Response samples

Content type
json
{
  • "members": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new membership

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

Request Body schema: json
required

The membership

object

Responses

Request samples

Content type
json
{
  • "member": {
    }
}

Response samples

Content type
json
{
  • "member": {
    }
}

Update the membership

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

memberId
required
integer

The ID of a membership

Request Body schema: json
required

The membership

object (StatusPageMember)

Responses

Request samples

Content type
json
{
  • "member": {
    }
}

Response samples

Content type
json
{
  • "member": {
    }
}

Deletes the membership

Authorizations:
api_key
path Parameters
subdomain
required
string

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).

memberId
required
integer

The ID of a membership

Responses

Response samples

Content type
json
{
  • "error": 401
}

Organization Members

List all members

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

query Parameters
before
string

Used as a cursor for pagination.

after
string

Used as a cursor for pagination.

limit
integer

Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.

email
string

Filter the members by email.

Responses

Response samples

Content type
json
{
  • "members": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Adds a new membership

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

Request Body schema: json
required

The membership

object

Responses

Request samples

Content type
json
{
  • "member": {
    }
}

Response samples

Content type
json
{
  • "member": {
    }
}

Update the membership

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

memberId
required
integer

The ID of a membership

Request Body schema: json
required

The membership

object (OrganizationMember)

Responses

Request samples

Content type
json
{
  • "member": {
    }
}

Response samples

Content type
json
{
  • "member": {
    }
}

Deletes the membership

Authorizations:
api_key
path Parameters
organizationId
required
integer

The ID of the organization

memberId
required
integer

The ID of a membership

Responses

Response samples

Content type
json
{
  • "error": 401
}