Status200
Ресурс

Status Page

Manage status pages for your project.

Модель Status Page

Свойства

  • Имя
    _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

  • Имя
    name
    Тип
    TextОбязательно
    Описание

    Any friendly name of this object

  • Имя
    pageTitle
    Тип
    Text
    Описание

    Title of your Status Page. This is used for SEO.

  • Имя
    pageDescription
    Тип
    Long Text
    Описание

    Description of your Status Page. This is used for SEO.

  • Имя
    description
    Тип
    Long Text
    Описание

    Friendly description that will help you remember

  • Имя
    slug
    Тип
    SlugОбязательно
    Описание

    Friendly globally unique name for your object

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    labels
    Тип
    Label
    Описание

    Relation to Labels Array where this object is categorized in.

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    faviconFile
    Тип
    File
    Описание

    Status Page Favicon

  • Имя
    faviconFileId
    Тип
    Object ID
    Описание

    Status Page Favicon File ID

  • Имя
    logoFile
    Тип
    File
    Описание

    Status Page Logo

  • Имя
    logoFileId
    Тип
    Object ID
    Описание

    Status Page Logo File ID

  • Имя
    coverImageFile
    Тип
    File
    Описание

    Status Page Cover Image

  • Имя
    coverImageFileId
    Тип
    Object ID
    Описание

    Status Page Cover Image ID

  • Имя
    headerHTML
    Тип
    HTML
    Описание

    Status Page Custom HTML Header

  • Имя
    footerHTML
    Тип
    HTML
    Описание

    Status Page Custom HTML Footer

  • Имя
    customCSS
    Тип
    CSS
    Описание

    Status Page Custom CSS Header

  • Имя
    customJavaScript
    Тип
    JavaSCript
    Описание

    Status Page Custom JavaScript. This runs when the status page is loaded.

  • Имя
    isPublicStatusPage
    Тип
    Boolean
    Описание

    Is this status page public?

  • Имя
    enableMasterPassword
    Тип
    Boolean
    Описание

    Require visitors to enter a master password before viewing a private status page.

  • Имя
    masterPassword
    Тип
    Hashed String
    Описание

    Password required to unlock a private status page. This value is stored as a secure hash.

  • Имя
    showIncidentLabelsOnStatusPage
    Тип
    Boolean
    Описание

    Show Incident Labels on Status Page?

  • Имя
    showScheduledEventLabelsOnStatusPage
    Тип
    Boolean
    Описание

    Show Scheduled Event Labels on Status Page?

  • Имя
    enableSubscribers
    Тип
    Boolean
    Описание

    Can subscribers subscribe to this Status Page?

  • Имя
    enableEmailSubscribers
    Тип
    Boolean
    Описание

    Can email subscribers subscribe to this Status Page?

  • Имя
    allowSubscribersToChooseResources
    Тип
    Boolean
    Описание

    Can subscribers choose which resources to subscribe to?

  • Имя
    allowSubscribersToChooseEventTypes
    Тип
    Boolean
    Описание

    Can subscribers choose which event type like Announcements, Incidents, Scheduled Events to subscribe to?

  • Имя
    enableSmsSubscribers
    Тип
    Boolean
    Описание

    Can SMS subscribers subscribe to this Status Page?

  • Имя
    enableSlackSubscribers
    Тип
    Boolean
    Описание

    Can Slack subscribers subscribe to this Status Page?

  • Имя
    enableMicrosoftTeamsSubscribers
    Тип
    Boolean
    Описание

    Can Microsoft Teams subscribers subscribe to this Status Page?

  • Имя
    copyrightText
    Тип
    Text
    Описание

    Copyright Text

  • Имя
    customFields
    Тип
    JSON
    Описание

    Custom Fields on this resource.

  • Имя
    requireSsoForLogin
    Тип
    BooleanОбязательно
    Описание

    Should SSO be required to login to Private Status Page

  • Имя
    smtpConfig
    Тип
    Entity
    Описание

    Relation to SMTP Config Resource which is used to send email to subscribers.

  • Имя
    smtpConfigId
    Тип
    Object ID
    Описание

    ID of your SMTP Config Resource which is used to send email to subscribers.

  • Имя
    callSmsConfig
    Тип
    Entity
    Описание

    Relation to Call/SMS Config Resource which is used to send SMS to subscribers.

  • Имя
    callSmsConfigId
    Тип
    Object ID
    Описание

    ID of your Call/SMS Config Resource which is used to send SMS to subscribers.

  • Имя
    showIncidentHistoryInDays
    Тип
    NumberОбязательно
    Описание

    How many days of incident history should be shown on the status page (in days)?

  • Имя
    showAnnouncementHistoryInDays
    Тип
    NumberОбязательно
    Описание

    How many days of announcement history should be shown on the status page (in days)?

  • Имя
    showScheduledEventHistoryInDays
    Тип
    NumberОбязательно
    Описание

    How many days of scheduled event history should be shown on the status page (in days)?

  • Имя
    overviewPageDescription
    Тип
    Markdown
    Описание

    Overview Page description for your status page. This is a markdown field.

  • Имя
    hidePoweredByBranding
    Тип
    Boolean
    Описание

    Hide Powered By Branding?

  • Имя
    defaultBarColor
    Тип
    Color
    Описание

    Default color of the bar on the overview page

  • Имя
    downtimeMonitorStatuses
    Тип
    Monitor Status
    Описание

    List of monitors statuses that are considered as "down" for this status page.

  • Имя
    subscriberTimezones
    Тип
    JSON
    Описание

    Timezones of subscribers to this status page.

  • Имя
    isReportEnabled
    Тип
    Boolean
    Описание

    Is Report Enabled for this Status Page?

  • Имя
    reportStartDateTime
    Тип
    Date
    Описание

    When would you like to send the first report?

  • Имя
    reportRecurringInterval
    Тип
    JSON
    Описание

    How often would you like to send the report?

  • Имя
    sendNextReportBy
    Тип
    Date
    Описание

    When should the next report be sent?

  • Имя
    reportDataInDays
    Тип
    Number
    Описание

    How many days of data should be included in the report?

  • Имя
    showOverallUptimePercentOnStatusPage
    Тип
    Boolean
    Описание

    Show Overall Uptime Percent on Status Page?

  • Имя
    overallUptimePercentPrecision
    Тип
    Text
    Описание

    Overall Precision of uptime percent for this status page.

  • Имя
    subscriberEmailNotificationFooterText
    Тип
    Very Long Text
    Описание

    Text to send to subscribers in the footer of the email.

  • Имя
    enableCustomSubscriberEmailNotificationFooterText
    Тип
    Boolean
    Описание

    Enable custom footer text in subscriber email notifications.

  • Имя
    showIncidentsOnStatusPage
    Тип
    Boolean
    Описание

    Show Incidents on Status Page?

  • Имя
    showAnnouncementsOnStatusPage
    Тип
    Boolean
    Описание

    Show Announcements on Status Page?

  • Имя
    showEpisodesOnStatusPage
    Тип
    Boolean
    Описание

    Show Incident Episodes on Status Page?

  • Имя
    showEpisodeHistoryInDays
    Тип
    Number
    Описание

    How many days of episode history to show on the status page

  • Имя
    showEpisodeLabelsOnStatusPage
    Тип
    Boolean
    Описание

    Show Episode Labels on Status Page?

  • Имя
    showScheduledMaintenanceEventsOnStatusPage
    Тип
    Boolean
    Описание

    Show Scheduled Maintenance Events on Status Page?

  • Имя
    showSubscriberPageOnStatusPage
    Тип
    Boolean
    Описание

    Show Subscriber Page on Status Page?

  • Имя
    ipWhitelist
    Тип
    Very Long Text
    Описание

    IP Whitelist for this Status Page. One IP per line. Only used if the status page is private.

  • Имя
    enableEmbeddedOverallStatus
    Тип
    Boolean
    Описание

    Enable embedded overall status badge that can be displayed on external websites?

  • Имя
    embeddedOverallStatusToken
    Тип
    Text
    Описание

    Security token required to access the embedded overall status badge. This token must be provided in the URL.

GETorPOST/api/status-page/get-list

Список

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

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

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

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

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

POST
/api/status-page/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "pageDescription": true,
    "pageTitle": true
  },
  "query": {
    "name": "Acme Corp Status Page"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    },
    {
      "_id": "377b7cc1-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    },
    {
      "_id": "377b7cc2-28fe-11f1-b591-3fdcef396aba",
      "name": "Acme Corp Status Page",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Public status page for Acme Corp customer-facing services",
      "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
      "pageTitle": "Acme Corp System Status"
    }
  ]
}
GETorPOST/api/status-page/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/status-page/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "pageDescription": true,
    "pageTitle": true
  }
}

Ответ

{
  "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acme Corp Status Page",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Public status page for Acme Corp customer-facing services",
  "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
  "pageTitle": "Acme Corp System Status"
}
POST/api/status-page/count

Количество

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

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

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

POST
/api/status-page/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "name": "Acme Corp Status Page"
  }
}

Ответ

{
  "count": 107
}
POST/api/status-page

Создать Status Page

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

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

POST
/api/status-page
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "Acme Corp Status Page",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "description": "Public status page for Acme Corp customer-facing services",
    "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
    "pageTitle": "Acme Corp System Status"
  }
}

Ответ

{
  "_id": "377b7cc0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acme Corp Status Page",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Public status page for Acme Corp customer-facing services",
  "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure.",
  "pageTitle": "Acme Corp System Status"
}
PUT/api/status-page/:id

Обновить по ID

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

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

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

POST/api/status-page/:id/update-item
GET/api/status-page/:id/update-item

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

PUT
/api/status-page/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "Acme Corp Status Page",
    "description": "Public status page for Acme Corp customer-facing services",
    "pageDescription": "Current status and uptime information for all Acme Corp services and infrastructure."
  }
}

Ответ

{}
DELETE/api/status-page/:id

Удалить по ID

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

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

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

POST/api/status-page/:id/delete-item
GET/api/status-page/:id/delete-item

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

DELETE
/api/status-page/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Status Page
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Status Page

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Status Page

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Status Page