API-referentie voor onderhoud

Al het onderhoud van een pagina ophalen

Endpoint:

GET /v2/:page_id/maintenances?page=:page&per_page=:per_page

• Het standaard paginanummer is 1.
• De standaardwaarde voor per_page is 50; het maximum is 100 items per pagina.

Voorbeeldrespons:

[
  {
    "id": "ckf1fzzbt4nib0a352wwra6ff",
    "name": "Test maintenance",
    "status": "NOTSTARTEDYET",
    "start": "2020-09-13T18:38:58.326Z",
    "duration": 60,
    "notifyStart": true,
    "notifyEnd": true,
    "notifyEarly": true,
    "notifyMinutes": 60,
    "autoStart": true,
    "autoEnd": true,
    "updates": [
      {
        "id": "ckf1fzzpal97v0a322evc874c",
        "message": "We are planning for a scheduled maintenance during that time.",
        "messageHtml": "<p>We are planning for a scheduled maintenance during that time.</p>",
        "status": "NOTSTARTEDYET",
        "notify": true,
        "started": "2020-09-13T18:38:58.326Z",
        "ended": null,
        "updatedAt": "2020-09-13T18:38:58.326Z"
      }
    ]
  }
]

Een onderhoudsvenster ophalen

Endpoint:

GET /v1/:page_id/maintenances/:maintenance_id

Voorbeeldrespons:

{
  "id": "ckf1fzzbt4nib0a352wwra6ff",
  "name": "Test maintenance",
  "status": "NOTSTARTEDYET",
  "start": "2020-09-13T18:38:58.326Z",
  "duration": 60,
  "notifyStart": true,
  "notifyEnd": true,
  "notifyEarly": true,
  "notifyMinutes": 60,
  "autoStart": true,
  "autoEnd": true,
  "updates": [
    {
      "id": "ckf1fzzpal97v0a322evc874c",
      "message": "We are planning for a scheduled maintenance during that time.",
      "messageHtml": "<p>We are planning for a scheduled maintenance during that time.</p>",
      "status": "NOTSTARTEDYET",
      "notify": true,
      "started": "2020-09-13T18:38:58.326Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-13T18:39:16.606Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Onderhoud toevoegen

Endpoint:

POST /v1/:page_id/maintenances

Voorbeeldverzoek:

{
  "name": "Test maintenance",
  "message": "We are scheduling a test maintenance",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "start": "2020-09-12 05:38:47.998",
  "end": "2020-09-12 06:38:47.998",
  "status": "NOTSTARTEDYET",
  "notify": true,
  "duration": 60,
  "notifyStart": true,
  "notifyEnd": true,
  "notifyEarly": true,
  "notifyMinutes": 60,
  "autoStart": true,
  "autoEnd": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "UNDERMAINTENANCE"
    }
  ],
  "translations": {
    "name": {
      "fr": "Entretien des tests"
    },
    "message": {
      "fr": "Nous planifions une maintenance test"
    }
  }
}

Onderhoudsvensters zijn standaard uitgeklapt.

Wil je je onderhoud inklappen en het op een gekozen moment uitklappen, stuur dan isCollapsed mee met de waarde true en expandAt met het gewenste tijdstip.

Voorbeeldrespons:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5",
  "name": "Test maintenance",
  "duration": null,
  "start": "2020-09-12T03:38:47.998Z",
  "end": "2020-09-12T04:38:47.998Z",
  "status": "NOTSTARTEDYET",
  "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": "Entretien des tests"
    },
    "message": {
      "fr": "Nous planifions une maintenance test"
    }
  }
}

Onderhoud bijwerken

Endpoint:

PUT /v1/:page_id/maintenances/:maintenance_id

Voorbeeldverzoek:

{
  "name": "Test incident 2",
  "message": "We are scheduling a test maintenance",
  "components": ["ckf01fvnxywz50a35nh1qzssm"],
  "start": "2020-09-12 05:38:47.998",
  "end": "2020-09-12 06:38:47.998",
  "status": "NOTSTARTEDYET",
  "notify": true,
  "statuses": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "status": "UNDERMAINTENANCE"
    }
  ],
  "translations": {
    "name": {
      "fr": "Entretien des tests"
    },
    "message": {
      "fr": "Nous planifions une maintenance test"
    }
  }
}

Voorbeeldrespons:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5",
  "name": "Test maintenance 2",
  "status": "NOTSTARTEDYET",
  "start": "2020-09-12T03:38:47.998Z",
  "duration": null,
  "updates": [
    {
      "id": "ckf1g4ffi4o5y0a35rm76vuq9",
      "message": "We're currently investigating an issue with the Website",
      "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
      "status": "NOTSTARTEDYET",
      "notify": true,
      "started": "2020-09-12T03:38:47.998Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-13T18:42:43.614Z"
    }
  ],
  "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": "Entretien des tests"
    },
    "message": {
      "fr": "Nous planifions une maintenance test"
    }
  }
}

Onderhoud verwijderen

Endpoint:

DELETE /v1/:page_id/maintenances/:maintenance_id

Voorbeeldrespons:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5"
}