Ресурс

Status Page Group

Manage groups on your status page and categorize resources like monitors into these groups.

Модель Status Page Group

Свойства

Имя
_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
Имя
statusPage
Тип
Status Page
Описание
Relation to Status Page Resource in which this object belongs
Имя
statusPageId
Тип
Object IDОбязательно
Описание
ID of your Status Page resource where this object belongs
Имя
name
Тип
TextОбязательно
Описание
Name of the Group
Имя
slug
Тип
SlugОбязательно
Описание
Friendly globally unique name for your object
Имя
description
Тип
Markdown
Описание
Description for this group. This is visible on Status Page. This can be in markdown format.
Имя
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)
Имя
order
Тип
Number
Описание
Order / Priority of this resource
Имя
isExpandedByDefault
Тип
Boolean
Описание
Is this group expanded by default on Status Page?
Имя
showCurrentStatus
Тип
Boolean
Описание
Show current status like offline, operational or degraded.
Имя
showUptimePercent
Тип
Boolean
Описание
Show uptime percent of this group for the last 90 days
Имя
uptimePercentPrecision
Тип
Text
Описание
Precision of uptime percent of this group for the last 90 days

GETorPOST/api/status-page-group/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "slug": true,
    "statusPageId": true,
    "createdByUserId": true
  },
  "query": {
    "name": "Core Services"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377c6720-28fe-11f1-b591-3fdcef396aba",
      "name": "Core Services",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "core-services",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901"
    },
    {
      "_id": "377c6721-28fe-11f1-b591-3fdcef396aba",
      "name": "Core Services",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "core-services",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901"
    },
    {
      "_id": "377c6722-28fe-11f1-b591-3fdcef396aba",
      "name": "Core Services",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "core-services",
      "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
      "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901"
    }
  ]
}

GETorPOST/api/status-page-group/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/status-page-group/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "slug": true,
    "statusPageId": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "377c6720-28fe-11f1-b591-3fdcef396aba",
  "name": "Core Services",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "core-services",
  "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
  "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901"
}

POST/api/status-page-group/count

Количество

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

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

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

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

POST

/api/status-page-group/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Core Services"
  }
}

Ответ

{
  "count": 107
}

POST/api/status-page-group

Создать Status Page Group

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

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

POST

/api/status-page-group

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Core Services",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
    "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901",
    "description": "Critical infrastructure services including API, database, and authentication"
  }
}

Ответ

{
  "_id": "377c6720-28fe-11f1-b591-3fdcef396aba",
  "name": "Core Services",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "core-services",
  "statusPageId": "f6a7b8c9-d0e1-2345-6789-abcdef012345",
  "createdByUserId": "f2a3b4c5-d6e7-89ab-cdef-012345678901"
}

PUT/api/status-page-group/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/status-page-group/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Core Services",
    "description": "Critical infrastructure services including API, database, and authentication",
    "isExpandedByDefault": true
  }
}

Ответ

{}

DELETE/api/status-page-group/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/status-page-group/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Status Page Group

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

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

Project Owner
Project Admin
Project Member
Edit Status Page Group

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

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

Project Owner
Project Admin
Project Member
Delete Status Page Group