Dokumentacja API awarii

Pobierz wszystkie awarie strony

Endpoint:

GET /v1/:page_id/outages?page=:page&per_page=:per_page

• Domyślny numer strony to 1.
• Domyślna wartość per_page to 50, a maksymalna to 100 elementów na stronę.

Przykładowa odpowiedź:

[
  {
    "id": "ckoutage1",
    "from": "2020-09-12T03:38:47.998Z",
    "to": "2020-09-12T04:38:47.998Z",
    "status": "PARTIALOUTAGE",
    "visibilityState": "PUBLISHED",
    "createdAt": "2020-09-12T03:38:47.998Z",
    "updatedAt": "2020-09-12T03:40:47.998Z",
    "component": {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website"
    },
    "incident": {
      "id": "ckf01m59ueaqb0a32wrljz1yd",
      "name": "Rocket is going down",
      "createdByType": "USER",
      "status": "INVESTIGATING"
    }
  }
]

Pobierz awarię

Endpoint:

GET /v1/:page_id/outages/:outage_id

Przykładowa odpowiedź:

{
  "id": "ckoutage1",
  "from": "2020-09-12T03:38:47.998Z",
  "to": "2020-09-12T04:38:47.998Z",
  "status": "PARTIALOUTAGE",
  "visibilityState": "PUBLISHED",
  "createdAt": "2020-09-12T03:38:47.998Z",
  "updatedAt": "2020-09-12T03:40:47.998Z",
  "component": {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website"
  },
  "incident": {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "createdByType": "USER",
    "status": "INVESTIGATING"
  }
}

Dodaj awarię

Endpoint:

POST /v1/:page_id/outages

Przykładowe żądanie:

{
  "componentId": "ckf01fvnxywz50a35nh1qzssm",
  "status": "PARTIALOUTAGE",
  "from": "2020-09-12 03:38:47.998",
  "to": "2020-09-12 04:38:47.998",
  "visibilityState": "PUBLISHED"
}

Przykładowa odpowiedź:

{
  "id": "ckoutage1",
  "from": "2020-09-12T03:38:47.998Z",
  "to": "2020-09-12T04:38:47.998Z",
  "status": "PARTIALOUTAGE",
  "visibilityState": "PUBLISHED",
  "createdAt": "2020-09-12T03:38:47.998Z",
  "updatedAt": "2020-09-12T03:40:47.998Z",
  "component": {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website"
  },
  "incident": null
}

Zaktualizuj awarię

Endpoint:

PUT /v1/:page_id/outages/:outage_id

Przykładowe żądanie:

{
  "status": "MAJOROUTAGE",
  "to": "2020-09-12 05:38:47.998"
}

Przykładowa odpowiedź:

{
  "id": "ckoutage1",
  "from": "2020-09-12T03:38:47.998Z",
  "to": "2020-09-12T05:38:47.998Z",
  "status": "MAJOROUTAGE",
  "visibilityState": "PUBLISHED",
  "createdAt": "2020-09-12T03:38:47.998Z",
  "updatedAt": "2020-09-12T04:40:47.998Z",
  "component": {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website"
  },
  "incident": null
}

Usuń awarię

Endpoint:

DELETE /v1/:page_id/outages/:outage_id

Przykładowa odpowiedź:

HTTP 204 No Content