⌘ K

API-Referenz für allgemeine Hinweise

Allgemeine Hinweise sind dauerhafte Banner auf Ihrer Statusseite (getrennt von Vorfällen und Wartungen). Über diese Endpunkte verwalten Sie sie programmatisch.

Alle allgemeinen Hinweise abrufen

Endpunkt:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page
  • Die Standard-Seitennummer ist 1.
  • Der Standardwert für per_page ist 50, das Maximum sind 100 Einträge pro Seite.

Beispielantwort:

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

Einen allgemeinen Hinweis abrufen

Endpunkt:

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

Beispielantwort:

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

Einen allgemeinen Hinweis hinzufügen

Endpunkt:

POST /v1/:page_id/generic-notices

Body-Parameter:

  • name (erforderlich) — der Titel des Hinweises.
  • message — der Text des Hinweises. HTML wird unterstützt.
  • notify — ob Abonnenten benachrichtigt werden. Standard ist false.
  • isCollapsed — ob der Hinweis standardmäßig eingeklappt ist. Standard ist false.
  • translations — optionale Übersetzungen für name und message, mit dem Sprachcode als Schlüssel.

Beispielanfrage:

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

Beispielantwort:

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

Einen allgemeinen Hinweis aktualisieren

Endpunkt:

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

Nur die von Ihnen gesendeten Felder werden aktualisiert.

Beispielanfrage:

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

Beispielantwort:

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

Einen allgemeinen Hinweis löschen

Endpunkt:

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

Beispielantwort:

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