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

Incident Updates

Incident Updates endpoints

Adds a new update to the given incident

post
/status_pages/{subdomain}/incidents/{incidentId}/updates
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).

incidentIdintegerRequired

The ID of an incident/maintenance

Body
Responses
200

The update was created

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

{
  "update": {
    "posted_at": "2022-01-01T00:00:00",
    "type": "issue",
    "description": "We have detected an issue with our CDN",
    "translations": {
      "en": {
        "description": "English description"
      },
      "es": {
        "description": "Spanish description"
      }
    },
    "notify": true,
    "tweet": true
  }
}
{
  "update": {
    "id": 89,
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00",
    "posted_at": "2022-01-01T00:00:00",
    "type": "issue",
    "description": "We have detected an issue with our CDN",
    "description_html": "<p>We have detected an issue with our CDN</p>",
    "translations": {
      "en": {
        "description": "English description"
      },
      "es": {
        "description": "Spanish description"
      }
    },
    "subscribers_notified_at": "2022-01-01T00:00:00",
    "tweet": true
  }
}

Updates an incident update

put
/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId}
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).

incidentIdintegerRequired

The ID of an incident/maintenance

updateIdintegerRequired
Body
Responses
200

The incident update was updated

application/json
put/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId}
PUT /api/v2/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "update": {
    "posted_at": "2022-01-01T00:00:00",
    "type": "issue",
    "description": "We have detected an issue with our CDN",
    "translations": {
      "en": {
        "description": "English description"
      },
      "es": {
        "description": "Spanish description"
      }
    },
    "notify": true,
    "tweet": true
  }
}
{
  "update": {
    "id": 89,
    "inserted_at": "2022-01-01T00:00:00",
    "updated_at": "2022-01-01T00:00:00",
    "posted_at": "2022-01-01T00:00:00",
    "type": "issue",
    "description": "We have detected an issue with our CDN",
    "description_html": "<p>We have detected an issue with our CDN</p>",
    "translations": {
      "en": {
        "description": "English description"
      },
      "es": {
        "description": "Spanish description"
      }
    },
    "subscribers_notified_at": "2022-01-01T00:00:00",
    "tweet": true
  }
}

Deletes incident update permanently

delete
/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId}
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).

incidentIdintegerRequired

The ID of an incident/maintenance

updateIdintegerRequired
Responses
200

Activity deleted successfully

delete/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId}
DELETE /api/v2/status_pages/{subdomain}/incidents/{incidentId}/updates/{updateId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated