Ресурс

Status Page Announcement Template

Manage announcement templates for your status page

Модель Status Page Announcement Template

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
templateName
Тип
TextОбязательно
Описание
Name of the announcement template
Имя
templateDescription
Тип
Long Text
Описание
Description of the announcement template
Имя
title
Тип
TextОбязательно
Описание
Title of the announcement
Имя
description
Тип
MarkdownОбязательно
Описание
Text of the announcement. This is in Markdown.
Имя
statusPages
Тип
Status Page
Описание
Status Pages to show this announcement on.
Имя
monitors
Тип
Monitor
Описание
List of monitors affected by this announcement template. If none are selected, all subscribers will be notified.
Имя
shouldStatusPageSubscribersBeNotified
Тип
Boolean
Описание
Should subscribers be notified about announcements created from this template?
Имя
createdByUser
Тип
User
Описание
Relation to User who created this object (if this object was created by a User)
Имя
createdByUserId
Тип
Object ID
Описание
User ID who created this object (if this object was created by a User)

GETorPOST/api/status-page-announcement-template/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Status Page Announcement Template». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать Status Page Announcement Template, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/status-page-announcement-template/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "description": true,
    "projectId": true,
    "templateName": true,
    "title": true,
    "createdByUser": true
  },
  "query": {
    "templateName": "Planned Upgrade Announcement"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377bcae1-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377bcae2-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateName": "Planned Upgrade Announcement",
      "title": "Scheduled System Upgrade - January 15, 2025",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

GETorPOST/api/status-page-announcement-template/:id/get-item

Получить по ID

Возвращает объект «Status Page Announcement Template» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/status-page-announcement-template/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "description": true,
    "projectId": true,
    "templateName": true,
    "title": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateName": "Planned Upgrade Announcement",
  "title": "Scheduled System Upgrade - January 15, 2025",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

POST/api/status-page-announcement-template/count

Количество

Возвращает количество ваших объектов «Status Page Announcement Template».

Необязательное тело запроса

query
Чтобы фильтровать Status Page Announcement Template, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/status-page-announcement-template/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "templateName": "Planned Upgrade Announcement"
  }
}

Ответ

{
  "count": 107
}

POST/api/status-page-announcement-template

Создать Status Page Announcement Template

Создаёт новый объект.

Запрос создания

POST

/api/status-page-announcement-template

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "templateName": "Planned Upgrade Announcement",
    "title": "Scheduled System Upgrade - January 15, 2025",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Ответ

{
  "_id": "377bcae0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateName": "Planned Upgrade Announcement",
  "title": "Scheduled System Upgrade - January 15, 2025",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

PUT/api/status-page-announcement-template/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/status-page-announcement-template/:id/update-item

GET/api/status-page-announcement-template/:id/update-item

Запрос обновления

PUT

/api/status-page-announcement-template/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "description": "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
    "templateName": "Planned Upgrade Announcement",
    "title": "Scheduled System Upgrade - January 15, 2025"
  }
}

Ответ

{}

DELETE/api/status-page-announcement-template/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/status-page-announcement-template/:id/delete-item

GET/api/status-page-announcement-template/:id/delete-item

Запрос удаления

DELETE

/api/status-page-announcement-template/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Status Page Announcement Template

Project Owner
Project Admin
Project Member
Read Status Page Announcement Template
Read All Project Resources

Права на создание

Нужны для создания Status Page Announcement Template

Project Owner
Project Admin
Project Member
Create Status Page Announcement Template

Права на обновление

Нужны для обновления Status Page Announcement Template

Project Owner
Project Admin
Project Member
Edit Status Page Announcement Template

Права на удаление

Нужны для удаления Status Page Announcement Template

Project Owner
Project Admin
Project Member
Delete Status Page Announcement Template