Status200
Ресурс

Probe

Manages custom probes. Deploy probes anywhere in the world and connect it to your project.

Модель 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.

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

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

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

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

    Friendly globally unique name for your object

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

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

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

    Probe Icon

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

    Probe Page Icon File ID

  • Имя
    project
    Тип
    Project
    Описание

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

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

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

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

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

    Auto Enable Probe on New Monitors

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

    Connection Status of the Probe

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

    Relation to Labels Array where this object is categorized in.

GETorPOST/api/probe/get-list

Список

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

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

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

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

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

POST
/api/probe/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "slug": true,
    "createdByUserId": true,
    "description": true,
    "iconFileId": true
  },
  "query": {
    "key": "Example value"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3777d340-28fe-11f1-b591-3fdcef396aba",
      "name": "US East Coast Probe",
      "slug": "us-east-coast-probe",
      "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
      "description": "Monitors services from the US East Coast region",
      "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    },
    {
      "_id": "3777d341-28fe-11f1-b591-3fdcef396aba",
      "name": "US East Coast Probe",
      "slug": "us-east-coast-probe",
      "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
      "description": "Monitors services from the US East Coast region",
      "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    },
    {
      "_id": "3777d342-28fe-11f1-b591-3fdcef396aba",
      "name": "US East Coast Probe",
      "slug": "us-east-coast-probe",
      "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
      "description": "Monitors services from the US East Coast region",
      "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  ]
}
GETorPOST/api/probe/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/probe/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "slug": true,
    "createdByUserId": true,
    "description": true,
    "iconFileId": true
  }
}

Ответ

{
  "_id": "3777d340-28fe-11f1-b591-3fdcef396aba",
  "name": "US East Coast Probe",
  "slug": "us-east-coast-probe",
  "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
  "description": "Monitors services from the US East Coast region",
  "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}
POST/api/probe/count

Количество

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

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

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

POST
/api/probe/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "key": "Example value"
  }
}

Ответ

{
  "count": 107
}
POST/api/probe

Создать Probe

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

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

POST
/api/probe
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "US East Coast Probe",
    "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
    "description": "Monitors services from the US East Coast region",
    "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
  }
}

Ответ

{
  "_id": "3777d340-28fe-11f1-b591-3fdcef396aba",
  "name": "US East Coast Probe",
  "slug": "us-east-coast-probe",
  "createdByUserId": "e5f6a7b8-c9d0-1234-ef12-345678901234",
  "description": "Monitors services from the US East Coast region",
  "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}
PUT/api/probe/:id

Обновить по ID

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

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

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

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

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

PUT
/api/probe/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "US East Coast Probe",
    "description": "Monitors services from the US East Coast region",
    "iconFileId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
  }
}

Ответ

{}
DELETE/api/probe/:id

Удалить по ID

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

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

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

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

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

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

Ответ

{}

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

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

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

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

  • Public
  • Project Owner
  • Project Admin
  • Project Member
  • Read Probe
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Probe

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Probe

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Probe