コンポーネント API リファレンス

ステータスページのコンポーネントをすべて取得する

エンドポイント:

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

• page の既定値は 1 です。
• per_page の既定値は 50 で、1 ページあたり最大 100 件です。

レスポンスの例:

[
  {
    "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"
  }
]

コンポーネントを取得する

エンドポイント:

GET /v2/:page_id/components/:component_id

レスポンスの例

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

コンポーネントを作成する

エンドポイント:

POST /v1/:page_id/components

リクエストの例:

{
  "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"
    }
  }
}

レスポンスの例:

{
  "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"
    }
  }
}

コンポーネントをグループの下に追加したい場合は、grouped を true に、group を対象グループの ID に設定します。

コンポーネントを更新する

エンドポイント:

PUT /v2/:page_id/components/:component_id

リクエストの例:

{
  "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"
    }
  }
}

レスポンスの例:

{
  "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"
    }
  }
}

コンポーネントのグループを変更したい場合は、grouped を true に、groupId を対象グループの ID に設定します。

コンポーネントを削除する

エンドポイント:

DELETE /v1/:page_id/components/:component_id

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm"
}