Documentation Powered by Redocly

Statuspal API Reference (2.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] URL: https://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

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.

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

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": [
    ]
}

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": [
    ]
}

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.

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

    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": {