⌘ K

API-Referenz für Vorfälle

Alle Vorfälle einer Seite abrufen

Endpunkt:

GET /v1/:page_id/incidents?page=:page&per_page=:per_page
  • Die Standard-Seitennummer ist 1.
  • Der Standardwert für per_page ist 50, das Maximum sind 100 Einträge pro Seite.

Beispielantwort:

[
  {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "started": "2020-09-12T19:05:17.398Z",
    "status": "RESOLVED",
    "resolved": "2020-09-12T19:09:04.498Z",
    "updates": [
      {
        "id": "ckf01m5ioeaqi0a32jtv8ovp8",
        "message": "We are currently investigating this incident.",
        "messageHtml": "<p>We are currently investigating this incident.</p>",
        "status": "INVESTIGATING",
        "notify": true,
        "started": "2020-09-12T19:05:17.398Z",
        "ended": null,
        "duration": 228,
        "createdAt": "2020-09-12T19:08:50.160Z"
      },
      {
        "id": "ckf01mnk9eaui0a32mmhgq68g",
        "message": "This incident has been resolved.",
        "messageHtml": "<p>This incident has been resolved.</p>",
        "status": "RESOLVED",
        "notify": true,
        "started": "2020-09-12T19:09:04.498Z",
        "ended": null,
        "duration": null,
        "createdAt": "2020-09-12T19:09:13.545Z"
      }
    ],
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "PARTIALOUTAGE",
        "showUptime": true,
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null
        },
        "customImpactPercentage": 40
      }
    ],
    "user": {
      "id": "ckf01g7m4eaqb0a32fl7jl1xx",
      "name": "Buzz Aldrin",
      "email": "buzz@nasa.com"
    }
  }
]

Mit den Query-Parametern status und !status beschränken Sie die Ergebnisse auf Vorfälle, die einen Status aus einer kommagetrennten Liste haben bzw. nicht haben.

user ist das Workspace-Mitglied, das den Vorfall erstellt hat. Es ist null, wenn der Vorfall automatisch erstellt wurde (durch einen Monitor, eine Drittanbieter-Integration oder per E-Mail).

Einen Vorfall abrufen

Endpunkt:

GET /v1/:page_id/incidents/:incident_id

Beispielantwort:

{
  "id": "ckf01m59ueaqb0a32wrljz1yd",
  "name": "Rocket is going down",
  "status": "RESOLVED",
  "started": "2020-09-12T19:05:17.398Z",
  "resolved": "2020-09-12T19:09:04.498Z",
  "updates": [
    {
      "id": "ckf01m5ioeaqi0a32jtv8ovp8",
      "message": "We are currently investigating this incident.",
      "messageHtml": "<p>We are currently investigating this incident.</p>",
      "status": "INVESTIGATING",
      "notify": true,
      "started": "2020-09-12T19:05:17.398Z",
      "ended": null,
      "duration": 228,
      "createdAt": "2020-09-12T19:08:50.160Z"
    },
    {
      "id": "ckf01mnk9eaui0a32mmhgq68g",
      "message": "This incident has been resolved.",
      "messageHtml": "<p>This incident has been resolved.</p>",
      "status": "RESOLVED",
      "notify": true,
      "started": "2020-09-12T19:09:04.498Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-12T19:09:13.545Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "MAJOROUTAGE",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "user": {
    "id": "ckf01g7m4eaqb0a32fl7jl1xx",
    "name": "Buzz Aldrin",
    "email": "buzz@nasa.com"
  }
}

Einen Vorfall hinzufügen

Endpunkt:

POST /v1/:page_id/incidents

Beispielanfrage:

{
  "name": "Test incident",
  "message": "We're currently investigating an issue with the Website",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "started": "2020-09-12 05:38:47.998",
  "status": "INVESTIGATING",
  "notify": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "PARTIALOUTAGE",
      "customImpactPercentage": 40
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

Vorfälle werden standardmäßig auf Ihrer Statusseite veröffentlicht. Wenn Sie einen nicht veröffentlichten Vorfall erstellen möchten, geben Sie shouldPublish an und setzen Sie es auf false.

Beispielantwort:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

Einen Vorfall mit einer Vorlage hinzufügen

Endpunkt:

POST /v1/:page_id/incidents/:template

Beispielantwort:

{
  "id": "cl8hrdsdsasu441sv26yq",
  "name": "Investigating Template",
  "nameTranslationId": null,
  "notify": false,
  "status": "INVESTIGATING",
  "started": "2022-09-25T19:53:20.778Z",
  "resolved": null,
  "duration": null,
  "createdAt": "2022-09-25T19:53:20.800Z",
  "updatedAt": "2022-09-25T19:53:20.800Z",
  "automated": false,
  "impact": "MAJOROUTAGE",
  "appId": null,
  "siteId": "cl8hadasdasd6wkxdco",
  "importedFrom": null
}

Vorfall aktualisieren

Endpunkt:

PUT /v1/:page_id/incidents/:incident_id

Beispielanfrage:

{
  "name": "Test incident 2",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "started": "2020-09-12 05:38:47.998",
  "status": "INVESTIGATING",
  "notify": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "OPERATIONAL"
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

Beispielantwort:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident 2",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ],
  "translations": {
    "name": {
      "fr": "Incident de test"
    },
    "message": {
      "fr": "Nous enquêtons actuellement sur un problème avec le site Web"
    }
  }
}

Vorfall löschen

Endpunkt:

DELETE /v1/:page_id/incidents/:incident_id

Beispielantwort:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1"
}

Bearbeiter eines Vorfalls abrufen

Wer über die Bereitschaft für einen Vorfall benachrichtigt wurde, ob ihn schon jemand bestätigt hat und wer ihn leitet.

Endpunkt:

GET /v1/:page_id/incidents/:incident_id/responders

Beispielantwort:

{
  "incidentId": "ckf02l5m8z36j0a35qr9q1tq1",
  "paged": true,
  "acknowledged": true,
  "lead": {
    "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
    "name": "Sam Rivera",
    "email": "sam@example.com"
  },
  "pages": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "pagedAt": "2026-11-01T12:01:00.000Z"
    }
  ],
  "responders": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "status": "ACKNOWLEDGED",
      "acknowledgedAt": "2026-11-01T12:05:00.000Z",
      "declinedAt": null
    }
  ]
}

Einen Vorfall bestätigen

Bestätigt einen Vorfall als der Benutzer des API-Schlüssels. Die erste Bestätigung bricht jede noch ausstehende Eskalation ab, die weitere Personen benachrichtigen würde, und macht diese Person zur Leitung des Vorfalls, falls es noch keine gibt. Auf der Statusseite ändert sich nichts. Erneutes Bestätigen ist unbedenklich: alreadyAcknowledged ist dann true.

Endpunkt:

POST /v1/:page_id/incidents/:incident_id/acknowledge

Beispielantwort:

{
  "incidentId": "ckf02l5m8z36j0a35qr9q1tq1",
  "alreadyAcknowledged": false,
  "paged": true,
  "acknowledged": true,
  "lead": {
    "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
    "name": "Sam Rivera",
    "email": "sam@example.com"
  },
  "pages": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "pagedAt": "2026-11-01T12:01:00.000Z"
    }
  ],
  "responders": [
    {
      "teamMemberId": "clh8nmaan72592bfokqjqd95s1",
      "name": "Sam Rivera",
      "email": "sam@example.com",
      "status": "ACKNOWLEDGED",
      "acknowledgedAt": "2026-11-01T12:05:00.000Z",
      "declinedAt": null
    }
  ]
}