Dokumentacja API komponentów

Pobierz wszystkie komponenty swojej strony statusu

Endpoint:

GET /v2/:page_id/components?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": "ckf01fvnxywz60a35wdbn5gz5",
    "name": "App",
    "status": "OPERATIONAL",
    "uniqueEmail": "nasa-app-1nozrueut@automation.instatus.com",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null
  },
  {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website",
    "status": "OPERATIONAL",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null,
    "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com"
  }
]

Pobierz komponent

Endpoint:

GET /v2/:page_id/components/:component_id

Przykładowa odpowiedź

{
  "id": "ckf01fvnxywz50a35nh1qzssm",
  "name": "Website",
  "description": "",
  "status": "OPERATIONAL",
  "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com",
  "showUptime": true,
  "order": 0,
  "group": null
}

Utwórz komponent

Endpoint:

POST /v1/:page_id/components

Przykładowe żądanie:

{
  "name": "Test component",
  "description": "Testing",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false,
  "archived": false,
  "translations": {
    "name": {
      "fr": "Composant de test"
    },
    "description": {
      "fr": "En test"
    }
  }
}

Przykładowa odpowiedź:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component",
  "description": "Testing",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "showUptime": true,
  "order": 8,
  "group": null,
  "translations": {
    "name": {
      "fr": "Composant de test"
    },
    "description": {
      "fr": "En test"
    }
  }
}

Jeśli chcesz dodać komponent do grupy, ustaw grouped na true, a group na ID wybranej grupy.

Zaktualizuj komponent

Endpoint:

PUT /v2/:page_id/components/:component_id

Przykładowe żądanie:

{
  "name": "Test component 4",
  "description": "Test test test",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false,
  "archived": true,
  "translations": {
    "name": {
      "fr": "Composant de test 4"
    },
    "description": {
      "fr": "Test test test"
    }
  }
}

Przykładowa odpowiedź:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component 4",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "description": "Test test test",
  "showUptime": true,
  "order": 6,
  "group": null,
  "translations": {
    "name": {
      "fr": "Composant de test 4"
    },
    "description": {
      "fr": "Test test test"
    }
  }
}

Jeśli chcesz zmienić grupę komponentu, ustaw grouped na true, a groupId na ID wybranej grupy.

Usuń komponent

Endpoint:

DELETE /v1/:page_id/components/:component_id

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm"
}