Ресурс

Status Page Domain

Manage custom domains for your status page

Модель Status Page Domain

Свойства

Имя
_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
Имя
domain
Тип
Domain
Описание
Имя
domainId
Тип
Object IDОбязательно
Описание
Имя
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
Имя
subdomain
Тип
Text
Описание
Subdomain label for your status page such as 'status'. Leave blank or enter @ to use the root domain.
Имя
fullDomain
Тип
Text
Описание
Full domain of your status page (like status.acmeinc.com). This is autogenerated and is derived from subdomain and domain.
Имя
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)
Имя
isCnameVerified
Тип
BooleanОбязательно
Описание
Is CNAME Verified?
Имя
isSslOrdered
Тип
BooleanОбязательно
Описание
Is SSL ordered?
Имя
isSslProvisioned
Тип
BooleanОбязательно
Описание
Is SSL provisioned?
Имя
customCertificate
Тип
Very Long Text
Описание
Имя
customCertificateKey
Тип
Very Long Text
Описание
Имя
isCustomCertificate
Тип
Boolean
Описание

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

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "domainId": true,
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "fullDomain": true
  },
  "query": {
    "fullDomain": "status.acmeinc.com"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377c1900-28fe-11f1-b591-3fdcef396aba",
      "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "fullDomain": "status.acmeinc.com"
    },
    {
      "_id": "377c1901-28fe-11f1-b591-3fdcef396aba",
      "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "fullDomain": "status.acmeinc.com"
    },
    {
      "_id": "377c1902-28fe-11f1-b591-3fdcef396aba",
      "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "fullDomain": "status.acmeinc.com"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "domainId": true,
    "projectId": true,
    "statusPageId": true,
    "createdByUserId": true,
    "fullDomain": true
  }
}

Ответ

{
  "_id": "377c1900-28fe-11f1-b591-3fdcef396aba",
  "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "fullDomain": "status.acmeinc.com"
}

POST/api/status-page-domain/count

Количество

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

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

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

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

POST

/api/status-page-domain/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "fullDomain": "status.acmeinc.com"
  }
}

Ответ

{
  "count": 107
}

POST/api/status-page-domain

Создать Status Page Domain

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

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

POST

/api/status-page-domain

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
    "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
    "subdomain": "status"
  }
}

Ответ

{
  "_id": "377c1900-28fe-11f1-b591-3fdcef396aba",
  "domainId": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "fullDomain": "status.acmeinc.com"
}

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

Обновить по ID

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

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

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

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

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

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

PUT

/api/status-page-domain/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "subdomain": "status",
    "customCertificate": "Example value",
    "customCertificateKey": "Example value"
  }
}

Ответ

{}

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

Удалить по ID

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

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

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

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

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

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

DELETE

/api/status-page-domain/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Status Page Domain

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

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

Project Owner
Project Admin
Project Member
Edit Status Page Domain

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

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

Project Owner
Project Admin
Project Member
Delete Status Page Domain