Ресурс

Monitor Probe

Add probes to monitor your resource from multiple locations around the world.

Модель Monitor Probe

Свойства

Имя
_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 Status200 Project in which this object belongs
Имя
probe
Тип
Probe
Описание
Relation to Probe Resource in which this object belongs
Имя
probeId
Тип
Object IDОбязательно
Описание
ID of your Status200 Probe in which this object belongs
Имя
monitor
Тип
Monitor
Описание
Relation to Monitor Resource in which this object belongs
Имя
monitorId
Тип
Object IDОбязательно
Описание
ID of your Monitor in which this object belongs
Имя
lastPingAt
Тип
Date
Описание
Имя
nextPingAt
Тип
Date
Описание
Имя
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)
Имя
isEnabled
Тип
BooleanОбязательно
Описание
Имя
lastMonitoringLog
Тип
JSON
Описание

GETorPOST/api/monitor-probe/get-list

Список

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

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

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

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

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

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

POST

/api/monitor-probe/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isEnabled": true,
    "monitorId": true,
    "probeId": true,
    "projectId": true,
    "createdByUser": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37753b30-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
      "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
    },
    {
      "_id": "37753b31-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
      "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
    },
    {
      "_id": "37753b32-28fe-11f1-b591-3fdcef396aba",
      "isEnabled": true,
      "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
      "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
    }
  ]
}

GETorPOST/api/monitor-probe/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/monitor-probe/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isEnabled": true,
    "monitorId": true,
    "probeId": true,
    "projectId": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "37753b30-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
  "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
}

POST/api/monitor-probe/count

Количество

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

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

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

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

POST

/api/monitor-probe/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {}
}

Ответ

{
  "count": 107
}

POST/api/monitor-probe

Создать Monitor Probe

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

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

POST

/api/monitor-probe

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "isEnabled": true,
    "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
    "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
  }
}

Ответ

{
  "_id": "37753b30-28fe-11f1-b591-3fdcef396aba",
  "isEnabled": true,
  "monitorId": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
  "probeId": "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "createdByUser": "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a"
}

PUT/api/monitor-probe/:id

Обновить по ID

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

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

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

POST/api/monitor-probe/:id/update-item

GET/api/monitor-probe/:id/update-item

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

PUT

/api/monitor-probe/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "isEnabled": true
  }
}

Ответ

{}

DELETE/api/monitor-probe/:id

Удалить по ID

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

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

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

POST/api/monitor-probe/:id/delete-item

GET/api/monitor-probe/:id/delete-item

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

DELETE

/api/monitor-probe/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Monitor Probe

Project Owner
Project Admin
Project Member
Read Monitor Probe
Read All Project Resources

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

Нужны для создания Monitor Probe

Project Owner
Project Admin
Create Monitor Probe

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

Нужны для обновления Monitor Probe

Project Owner
Project Admin
Edit Monitor Probe

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

Нужны для удаления Monitor Probe

Project Owner
Project Admin
Delete Monitor Probe