Ресурс

Incident SLA Rule

Configure SLA rules to define response and resolution time targets for incidents

Модель Incident SLA Rule

Свойства

Имя
_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Обязательно
Описание
Name of this SLA rule
Имя
description
Тип
Long Text
Описание
Description of this SLA rule
Имя
order
Тип
NumberОбязательно
Описание
Order/priority of this rule. Rules are evaluated in order (lowest first). First matching rule wins.
Имя
isEnabled
Тип
BooleanОбязательно
Описание
Whether this SLA rule is enabled
Имя
responseTimeInMinutes
Тип
Number
Описание
Target response time in minutes. This is the maximum time allowed before the incident must be acknowledged.
Имя
resolutionTimeInMinutes
Тип
Number
Описание
Target resolution time in minutes. This is the maximum time allowed before the incident must be resolved.
Имя
atRiskThresholdInPercentage
Тип
NumberОбязательно
Описание
Percentage of the deadline at which the SLA status changes to At Risk. For example, 80 means the status becomes At Risk when 80% of the time has elapsed.
Имя
internalNoteReminderIntervalInMinutes
Тип
Number
Описание
How often (in minutes) to automatically post internal notes to unresolved incidents. Internal notes are only visible to your team. For example, set to 30 to remind your team every 30 minutes to provide an update. Leave empty to disable.
Имя
publicNoteReminderIntervalInMinutes
Тип
Number
Описание
How often (in minutes) to automatically post public notes to unresolved incidents. Public notes are visible to external stakeholders on your status page. For example, set to 60 to post a status update every hour. Leave empty to disable.
Имя
internalNoteReminderTemplate
Тип
Markdown
Описание
The content of the automatic internal note posted to your team. Use variables like {{incidentTitle}}, {{elapsedTime}}, {{slaStatus}}, {{timeToResolutionDeadline}} to include dynamic incident data. If left empty, a default template will be used.
Имя
publicNoteReminderTemplate
Тип
Markdown
Описание
The content of the automatic public note shown on your status page. Use variables like {{incidentTitle}}, {{elapsedTime}}, {{slaStatus}}, {{timeToResolutionDeadline}} to include dynamic incident data. If left empty, a default template will be used.
Имя
monitors
Тип
Monitor
Описание
Only apply this SLA rule to incidents affecting these monitors. Leave empty to match incidents from any monitor.
Имя
incidentSeverities
Тип
Incident Severity
Описание
Only apply this SLA rule to incidents with these severities. Leave empty to match incidents of any severity.
Имя
incidentLabels
Тип
Label
Описание
Only apply this SLA rule to incidents that have at least one of these labels. Leave empty to match incidents regardless of labels.
Имя
monitorLabels
Тип
Label
Описание
Only apply this SLA rule to incidents from monitors that have at least one of these labels. Leave empty to match incidents regardless of monitor labels.
Имя
incidentTitlePattern
Тип
Long Text
Описание
Regular expression pattern to match incident titles. Leave empty to match any title. Example: 'CPU.*high' matches titles containing 'CPU' followed by 'high'.
Имя
incidentDescriptionPattern
Тип
Long Text
Описание
Regular expression pattern to match incident descriptions. Leave empty to match any description.
Имя
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)

GETorPOST/api/incident-sla-rule/get-list

Список

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

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

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

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

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

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

POST

/api/incident-sla-rule/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "atRiskThresholdInPercentage": true,
    "isEnabled": true,
    "name": true,
    "order": true,
    "projectId": true
  },
  "query": {
    "name": "Example name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3771dfd0-28fe-11f1-b591-3fdcef396aba",
      "atRiskThresholdInPercentage": 100,
      "isEnabled": true,
      "name": "Example name",
      "order": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "3771dfd1-28fe-11f1-b591-3fdcef396aba",
      "atRiskThresholdInPercentage": 100,
      "isEnabled": true,
      "name": "Example name",
      "order": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "3771dfd2-28fe-11f1-b591-3fdcef396aba",
      "atRiskThresholdInPercentage": 100,
      "isEnabled": true,
      "name": "Example name",
      "order": 100,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

GETorPOST/api/incident-sla-rule/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/incident-sla-rule/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "atRiskThresholdInPercentage": true,
    "isEnabled": true,
    "name": true,
    "order": true,
    "projectId": true
  }
}

Ответ

{
  "_id": "3771dfd0-28fe-11f1-b591-3fdcef396aba",
  "atRiskThresholdInPercentage": 100,
  "isEnabled": true,
  "name": "Example name",
  "order": 100,
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

POST/api/incident-sla-rule/count

Количество

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

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

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

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

POST

/api/incident-sla-rule/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Example name"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-sla-rule

Создать Incident SLA Rule

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

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

POST

/api/incident-sla-rule

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "atRiskThresholdInPercentage": 100,
    "isEnabled": true,
    "name": "Example name",
    "order": 100,
    "projectId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "3771dfd0-28fe-11f1-b591-3fdcef396aba",
  "atRiskThresholdInPercentage": 100,
  "isEnabled": true,
  "name": "Example name",
  "order": 100,
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

PUT/api/incident-sla-rule/:id

Обновить по ID

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

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

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

POST/api/incident-sla-rule/:id/update-item

GET/api/incident-sla-rule/:id/update-item

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

PUT

/api/incident-sla-rule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "atRiskThresholdInPercentage": 100,
    "isEnabled": true,
    "name": "Example name"
  }
}

Ответ

{}

DELETE/api/incident-sla-rule/:id

Удалить по ID

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

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

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

POST/api/incident-sla-rule/:id/delete-item

GET/api/incident-sla-rule/:id/delete-item

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

DELETE

/api/incident-sla-rule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Incident SLA Rule

Project Owner
Project Admin
Project Member
Read Incident SLA Rule
Read All Project Resources

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

Нужны для создания Incident SLA Rule

Project Owner
Project Admin
Create Incident SLA Rule

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

Нужны для обновления Incident SLA Rule

Project Owner
Project Admin
Edit Incident SLA Rule

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

Нужны для удаления Incident SLA Rule

Project Owner
Project Admin
Delete Incident SLA Rule