⌘ K

Довідник API: загальні оголошення

Загальні оголошення — це постійні банери, які показуються на вашій сторінці статусу (окремо від інцидентів і технічного обслуговування). Використовуйте ці ендпоінти, щоб керувати ними програмно.

Отримати всі загальні оголошення

Ендпоінт:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page
  • Номер сторінки за замовчуванням — 1.
  • Значення per_page за замовчуванням — 50, максимум — 100 елементів на сторінку.

Приклад відповіді:

[
  {
    "id": "cl9mq0ah50646mpvlmbrvf979",
    "name": "Scheduled DNS migration",
    "message": "We are migrating our DNS provider over the next week.",
    "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
    "notify": false,
    "isCollapsed": false,
    "createdAt": "2022-10-24T11:53:46.505Z",
    "updatedAt": "2022-10-24T11:53:46.505Z",
    "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
    "importedFrom": null
  }
]

Отримати загальне оголошення

Ендпоінт:

GET /v1/:page_id/generic-notices/:generic_notice_id

Приклад відповіді:

{
  "id": "cl9mq0ah50646mpvlmbrvf979",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-10-24T11:53:46.505Z",
  "updatedAt": "2022-10-24T11:53:46.505Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

Додати загальне оголошення

Ендпоінт:

POST /v1/:page_id/generic-notices

Параметри тіла запиту:

  • name (обовʼязково) — заголовок оголошення.
  • message — текст оголошення. Підтримується HTML.
  • notify — чи сповіщати підписників. За замовчуванням false.
  • isCollapsed — чи згорнуте оголошення за замовчуванням. За замовчуванням false.
  • translations — необовʼязкові переклади для name і message за кодами мов.

Приклад запиту:

{
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "notify": false,
  "isCollapsed": false,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

Приклад відповіді:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-01T03:52:08.126Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

Оновити загальне оголошення

Ендпоінт:

PUT /v1/:page_id/generic-notices/:generic_notice_id

Оновлюються лише ті поля, які ви надсилаєте.

Приклад запиту:

{
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "isCollapsed": true
}

Приклад відповіді:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

Видалити загальне оголошення

Ендпоінт:

DELETE /v1/:page_id/generic-notices/:generic_notice_id

Приклад відповіді:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}