مرجع واجهة المكوّنات البرمجية

احصل على جميع مكوّنات صفحة الحالة

نقطة النهاية:

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

• رقم الصفحة الافتراضي هو ١.
• القيمة الافتراضية لـ per_page هي ٥٠ والحد الأقصى ١٠٠ عنصر في الصفحة.

مثال على الاستجابة:

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