For the complete documentation index, see llms.txt. This page is also available as Markdown.

Incident Templates

Incident Templates endpoints

Get the incident templates

get
/status_pages/{subdomain}/incident_templates
Authorizations
AuthorizationstringRequired
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 incident templates

application/json
get/status_pages/{subdomain}/incident_templates
GET /api/v2/status_pages/{subdomain}/incident_templates HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "incident_templates": [
    {
      "id": 1,
      "name": "Database outage",
      "title": "Incident template title",
      "description": "Some description",
      "service_ids": [
        1
      ],
      "incident_types": [
        "major"
      ],
      "translations": {
        "en": {
          "title": "English title",
          "description": "English description"
        },
        "es": {
          "title": "Spanish title",
          "description": "Spanish description"
        }
      }
    }
  ]
}

Adds a new incident template

post
/status_pages/{subdomain}/incident_templates
Authorizations
AuthorizationstringRequired
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).

Body
Responses
201

The incident template created

application/json
post/status_pages/{subdomain}/incident_templates
POST /api/v2/status_pages/{subdomain}/incident_templates HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "incident_template": {
    "name": "Database outage",
    "title": "Incident template title",
    "description": "Some description",
    "service_ids": [
      1
    ],
    "incident_types": [
      "major"
    ],
    "translations": {
      "en": {
        "title": "English title",
        "description": "English description"
      },
      "es": {
        "title": "Spanish title",
        "description": "Spanish description"
      }
    }
  }
}
{
  "incident_template": {
    "id": 1,
    "name": "Database outage",
    "title": "Incident template title",
    "description": "Some description",
    "service_ids": [
      1
    ],
    "incident_types": [
      "major"
    ],
    "translations": {
      "en": {
        "title": "English title",
        "description": "English description"
      },
      "es": {
        "title": "Spanish title",
        "description": "Spanish description"
      }
    }
  }
}

Get incident template against given incident template id

get
/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
Authorizations
AuthorizationstringRequired
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).

incidentTemplateIdintegerRequired

The ID of an incident template

Responses
200

The incident template details

application/json
get/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
GET /api/v2/status_pages/{subdomain}/incident_templates/{incidentTemplateId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "incident_template": {
    "id": 1,
    "name": "Database outage",
    "title": "Incident template title",
    "description": "Some description",
    "service_ids": [
      1
    ],
    "incident_types": [
      "major"
    ],
    "translations": {
      "en": {
        "title": "English title",
        "description": "English description"
      },
      "es": {
        "title": "Spanish title",
        "description": "Spanish description"
      }
    }
  }
}

Updates existing incident template

put
/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
Authorizations
AuthorizationstringRequired
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).

incidentTemplateIdintegerRequired

The ID of an incident template

Body
Responses
200

The incident template updated

application/json
put/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
PUT /api/v2/status_pages/{subdomain}/incident_templates/{incidentTemplateId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "incident_template": {
    "name": "Database outage",
    "title": "Incident template title",
    "description": "Some description",
    "service_ids": [
      1
    ],
    "incident_types": [
      "major"
    ],
    "translations": {
      "en": {
        "title": "English title",
        "description": "English description"
      },
      "es": {
        "title": "Spanish title",
        "description": "Spanish description"
      }
    }
  }
}
{
  "incident_template": {
    "id": 1,
    "name": "Database outage",
    "title": "Incident template title",
    "description": "Some description",
    "service_ids": [
      1
    ],
    "incident_types": [
      "major"
    ],
    "translations": {
      "en": {
        "title": "English title",
        "description": "English description"
      },
      "es": {
        "title": "Spanish title",
        "description": "Spanish description"
      }
    }
  }
}

Deletes incident template permanently

delete
/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
Authorizations
AuthorizationstringRequired
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).

incidentTemplateIdintegerRequired

The ID of an incident template

Responses
200

Incident template deleted successfully

delete/status_pages/{subdomain}/incident_templates/{incidentTemplateId}
DELETE /api/v2/status_pages/{subdomain}/incident_templates/{incidentTemplateId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated