Checkly (независимый издатель) (предварительная версия)

Проверяемая платформа мониторинга для современного стека: программируемая, гибкая и любящая JavaScript. Отслеживайте и проверяйте важные транзакции сайта. Автоматически собираются трассировки ошибок, снимки экрана и метрики производительности при каждой проверке.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Веб-сайт	https://www.checklyhq.com/
Политика конфиденциальности	https://www.checklyhq.com/privacy
Категории	ИТ-операции

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
ID счета	securestring	Идентификатор учетной записи для этого API.	True
Ключ API (в форме "Bearer apiKey"	securestring	Ключ API (в форме Bearer apiKey) для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Вывод списка всех групп проверки	Выводит список всех текущих групп проверки в вашей учетной записи. Свойство check — это массив проверяемых идентификаторов UUID для удобного ссылки. Он доступен только для чтения, и его нельзя использовать для добавления проверок в группу.
Вывод списка всех каналов оповещений	Перечисляет все настроенные каналы оповещений и их подписанные проверки.
Вывод списка всех оповещений для учетной записи	Выводит список всех оповещений для учетной записи.
Вывод списка всех панелей мониторинга	Выводит список всех текущих панелей мониторинга в вашей учетной записи.
Вывод списка всех периодов обслуживания	Выводит список всех окон обслуживания в учетной записи.
Вывод списка всех состояний проверки	Отображает текущие сведения о состоянии для всех проверок в вашей учетной записи. Записи состояния проверки постоянно обновляются при наличии новых результатов проверки.
Вывод списка всех частных расположений	Выводит список всех частных расположений в вашей учетной записи.
Вывод списка оповещений для определенной проверки	Выводит список всех оповещений для определенной проверки.
Обновление группы проверки	Обновляет группу проверки.
Обновление канала оповещений	Обновление канала оповещений.
Обновление панели мониторинга	Обновляет панель мониторинга. Возвращает значение 409 при попытке создать панель мониторинга с пользовательским URL-адресом или пользовательским доменом, который уже взят.
Обновление переменной среды	Обновляет переменную среды. Использует ключевое поле в качестве идентификатора для обновления. Обновляет только значение и заблокированное свойство.
Обновление периода обслуживания	Обновляет период обслуживания.
Обновление подписок канала оповещений	Обновите подписки канала оповещений. Используйте это, чтобы добавить проверку в канал оповещений, чтобы оповещения о сбоях и восстановлении отправлялись для этой проверки. Примечание. При передаче объекта подписки можно указать только checkId или groupId, а не оба.
Обновление проверки [УСТАРЕЛО]	[НЕ РЕКОМЕНДУЕТСЯ] Эта конечная точка будет удалена в понедельник 4 июля 2022 года. Используйте вместо этого PUT /checks/api/{id} или PUT /checks/browser/{id}. Обновляет новую проверку API или браузера.
Обновление проверки API	Обновляет проверку API.
Обновление проверки браузера	Обновляет проверку браузера.
Обновление фрагмента кода	Обновляет фрагмент кода.
Обновление частного расположения	Обновляет частное расположение.
Отображение сведений для одной конкретной среды выполнения	Отображает сведения обо всех включенных пакетах NPM и их версии для одной конкретной среды выполнения.
Перечисление всех переменных среды	Перечисляет все текущие переменные среды в учетной записи.
Перечисление всех проверок	Выводит список всех текущих проверок в вашей учетной записи.
Перечисление всех фрагментов	Выводит список всех текущих фрагментов в вашей учетной записи.
Получение всех проверок в определенной группе с примененными параметрами группы	Выводит список всех проверок в определенной группе проверки с примененными параметрами группы.
Получение группы проверки	Отображение сведений о определенной группе проверки.
Получение значка состояния группы	Получение индикатора состояния группы.
Получение значка состояния проверки	Получение индикатора состояния проверки.
Получение канала оповещений	Отображение сведений о определенном канале оповещений.
Получение метрик работоспособности частного расположения из периода времени	Получение метрик работоспособности частного расположения из периода времени.
Получение одной проверки в определенной группе с примененными параметрами группы	Отображение сведений о одной проверке определенной группы проверки с примененными параметрами группы.
Получение переменной среды	Отображение сведений о конкретной переменной среды. Использует ключевое поле для выбора.
Получение периода обслуживания	Отображение сведений о определенном окне обслуживания.
Получение проверки	Отображение сведений о конкретном API или проверке браузера.
Получение результата проверки	Отображение сведений о конкретном результате проверки.
Получение сведений о состоянии проверки	Отображение текущих сведений о состоянии для определенной проверки.
Получение триггера группы проверки	Находит триггер группы проверки.
Получение триггера проверки	Находит триггер проверки.
Получение фрагмента кода	Отображение сведений о конкретном фрагменте кода.
Получение частного расположения	Отображение сведений о конкретном частном расположении.
Создает настраиваемый отчет для всех метрик проверки браузера	Создает отчет с агрегированной или не агрегированной статистикой для определенного периода времени проверки браузера.
Создает отчет с статистической статистикой для проверок и проверок групп	Создает отчет с агрегированной статистикой для всех проверок или отфильтрованного набора проверок в течение указанного периода времени.
Создание группы проверки	Создает новую группу проверки. Вы можете добавить проверки в группу, задав свойство groupId отдельных проверок.
Создание канала оповещений	Создает новый канал генерации оповещений.
Создание нового ключа API для частного расположения	Создает ключ API в частном расположении.
Создание панели мониторинга	Создает новую панель мониторинга. Возвращает значение 409 при попытке создать панель мониторинга с пользовательским URL-адресом или пользовательским доменом, который уже взят.
Создание переменной среды	Создает новую переменную среды.
Создание периода обслуживания	Создает новое окно обслуживания.
Создание проверки [УСТАРЕЛО]	[НЕ РЕКОМЕНДУЕТСЯ] Эта конечная точка будет удалена в понедельник 4 июля 2022 года. Используйте вместо этого POST /checks/api или POST /checks/browser. Создает новую проверку API или браузера. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingsможет alertSettings быть null
Создание проверки API	Создает новую проверку API. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingможет alertSetting быть null
Создание проверки браузера	Создает новую проверку браузера. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingможет alertSetting быть null
Создание триггера группы проверки	Создает триггер группы проверки.
Создание триггера проверки	Создает триггер проверки.
Создание фрагмента кода	Создает новый фрагмент кода.
Создание частного расположения	Создает новое частное расположение.
Список всех поддерживаемых расположений	Выводит список всех поддерживаемых расположений.
Список всех поддерживаемых сред выполнения	Перечисляет все поддерживаемые среды выполнения и включенные пакеты NPM для проверок браузера и настройки и слезоточивых сценариев для проверок API.
Список всех результатов проверки	Выводит полные необработанные результаты проверки для определенной проверки. Мы сохраняем необработанные результаты в течение 30 дней. Через 30 дней они удаляются. Однако мы сохраняем свернутые результаты на неопределенный период. Вы можете фильтровать по типу проверки и типу результатов, чтобы сузить список. to Используйте параметры для from указания диапазона дат (метка времени UNIX в секундах). В зависимости от типа проверки некоторые поля могут иметь значение NULL. Эта конечная точка вернет данные в течение шести часов. Если задано значение от и до парам, они должны быть не более шести часов. Если ни один из них не задан, мы рассмотрим парам, чтобы быть сейчас и от param быть шесть часов ранее. Если задано значение только для параметра, то мы задали значение от шести часов раньше. Напротив, если только от парама задано, мы рассмотрим парам, чтобы быть шесть часов спустя. Ограничение скорости применяется к этой конечной точке, вы можете отправлять 5 запросов / 10 секунд в большей степени.
Удаление группы проверки	Окончательно удаляет группу проверок. Невозможно удалить группу проверки, если она по-прежнему содержит проверки.
Удаление канала оповещений	Окончательно удаляет канал генерации оповещений.
Удаление панели мониторинга	Окончательно удаляет панель мониторинга.
Удаление переменной среды	Окончательно удаляет переменную среды. Использует поле ключа в качестве идентификатора для удаления.
Удаление периода обслуживания	Окончательно удаляет период обслуживания.
Удаление проверки	Окончательно удаляет проверку API или браузера и все связанные с ней данные о состоянии и результатах.
Удаление существующего ключа API для частного расположения	Окончательно удаляет ключ API из частного расположения.
Удаление триггера группы проверки	Удаляет триггер групп проверки.
Удаление триггера проверки	Удаляет триггер проверки.
Удаление фрагмента кода	Окончательно удаляет фрагмент кода.
Удаление частного расположения	Окончательно удаляет частное расположение.

Вывод списка всех групп проверки

Идентификатор операции:

GetV1Checkgroups

Выводит список всех текущих групп проверки в вашей учетной записи. Свойство check — это массив проверяемых идентификаторов UUID для удобного ссылки. Он доступен только для чтения, и его нельзя использовать для добавления проверок в группу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

CheckGroupList

Вывод списка всех каналов оповещений

Идентификатор операции:

GetV1Alertchannels

Перечисляет все настроенные каналы оповещений и их подписанные проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

AlertChannelList

Вывод списка всех оповещений для учетной записи

Идентификатор операции:

GetV1Checkalerts

Выводит список всех оповещений для учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.
От	from		date	Выберите документы из этой метки времени UNIX (>= дата). По умолчанию — 6 часов.
Кому	to		date	Выберите оповещения до этой метки времени UNIX (< дата). Значение по умолчанию — 6 часов после этого.

Возвращаемое значение

Товары

CheckAlertList

Вывод списка всех панелей мониторинга

Идентификатор операции:

GetV1Dashboards

Выводит список всех текущих панелей мониторинга в вашей учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

DashboardsList

Вывод списка всех периодов обслуживания

Идентификатор операции:

GetV1Maintenancewindows

Выводит список всех окон обслуживания в учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Список периодов обслуживания.

Товары

MaintenanceWindowList

Вывод списка всех состояний проверки

Идентификатор операции:

GetV1Checkstatuses

Отображает текущие сведения о состоянии для всех проверок в вашей учетной записи. Записи состояния проверки постоянно обновляются при наличии новых результатов проверки.

Возвращаемое значение

Товары

CheckStatusList

Вывод списка всех частных расположений

Идентификатор операции:

GetV1Privatelocations

Выводит список всех частных расположений в вашей учетной записи.

Возвращаемое значение

Товары

privateLocationsListSchema

Вывод списка оповещений для определенной проверки

Идентификатор операции:

GetV1CheckalertsCheckid

Выводит список всех оповещений для определенной проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.
От	from		date	Выберите документы из этой метки времени UNIX (>= дата). По умолчанию — 6 часов.
Кому	to		date	Выберите оповещения до этой метки времени UNIX (< дата). Значение по умолчанию — 6 часов после этого.

Возвращаемое значение

Товары

CheckAlertList

Обновление группы проверки

Идентификатор операции:

PutV1CheckgroupsId

Обновляет группу проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name		string	Имя группы проверки.
Activated	activated		boolean	Определяет, выполняются ли проверки в группе.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки в этой группе и (или) восстановления.
Проверка списка тегов группы	tags		array of string	Теги для организации и фильтрации проверок.
Проверка списка расположений группы	locations		array of string	Массив одного или нескольких расположений центра обработки данных для выполнения проверок.
Concurrency	concurrency		number	Определяет, сколько проверок вызывается одновременно при активации группы проверки из CI/CD или через API.
URL	url		string	Базовый URL-адрес для этой группы, на который можно ссылаться с переменной {{GROUP_BASE_URL}}} во всех проверках группы.
Key	key	True	string	Ключ.
Ценность	value	True	string	Значение.
Заблокировано	locked		boolean	Заблокировано ли.
Исходный материал	source		string	Источник.
Недвижимость	property		string	Свойство.
Comparison	comparison		string	Сравнение.
Цель	target		string	Цель.
Имя пользователя	username	True	string	Имя пользователя.
Пароль	password	True	string	Пароль.
Проверка по умолчанию проверки группы создания браузера	browserCheckDefaults		object	Группа проверки создает параметры браузера по умолчанию.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения проверок в этой группе.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой группе проверки.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API в этой группе.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, который будет использоваться на этапе отлезения проверки API в этой группе.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для запуска на этапе установки проверки API в этой группе.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе отлезения проверки API в этой группе.
Проверка частных расположений	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckGroup

Обновление канала оповещений

Идентификатор операции:

PutV1AlertchannelsId

Обновление канала оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Идентификатор	id		number	Идентификатор.
Проверка идентификатора	checkId		guid	Идентификатор проверки.
Идентификатор группы	groupId		number	Идентификатор группы.
Activated	activated	True	boolean	Активируется ли активация.
Тип	type	True	string	Тип.
Создание конфигурации канала оповещений	config	True	object	Канал оповещений создает конфигурацию.
Отправка восстановления	sendRecovery		boolean	Указывает, отправляется ли восстановление.
Сбой отправки	sendFailure		boolean	Указывает, сбой отправки.
Отправка с пониженным состоянием	sendDegraded		boolean	Состояние отправки ухудшается.
Срок действия SSL	sslExpiry		boolean	Определяет, следует ли отправлять оповещение для истечения срока действия SSL-сертификатов.
Пороговое значение истечения срока действия SSL	sslExpiryThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.

Возвращаемое значение

Тело

AlertChannel

Обновление панели мониторинга

Идентификатор операции:

PutV1DashboardsDashboardid

Обновляет панель мониторинга. Возвращает значение 409 при попытке создать панель мониторинга с пользовательским URL-адресом или пользовательским доменом, который уже взят.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	dashboardId	True	string	Идентификатор панели мониторинга.
Пользовательский URL-адрес	customUrl		string	Имя поддомена в checklyhq.com. Необходимо быть уникальным для всех пользователей.
Личный домен	customDomain		string	Личный домен пользователя, например status.example.com. Ознакомьтесь с документацией по обновлению использования DNS и SSL.
Logo	logo		string	URL-адрес, указывающий на файл изображения.
Favicon	favicon		string	URL-адрес, указывающий на файл изображения, используемый в качестве панели мониторинга favicon.
Link	link		string	Ссылка URL-адреса для перенаправления при нажатии логотипа панели мониторинга.
Header	header		string	Часть текста, отображаемая в верхней части панели мониторинга.
Description	description		string	Фрагмент текста, отображаемый под заголовком или заголовком панели мониторинга.
Ширина	width		string	Определяет, следует ли использовать весь экран или фокус в центре.
Частота обновления	refreshRate		number	Как часто обновлять панель мониторинга в секундах.
Нумеровать страницы	paginate		boolean	Определяет включение или отключение разбиения на страницы.
Скорость разбиения на страницы	paginationRate		number	Как часто запускать разбиение на страницы в секундах.
Проверка на страницу	checksPerPage		number	Количество проверок, отображаемых на странице.
Использование и оператор	useTagsAndOperator		boolean	Когда следует использовать оператор AND для поиска тегов.
Скрытие тегов	hideTags		boolean	Отображение или скрытие тегов на панели мониторинга.
Список тегов панели мониторинга	tags		array of string	Список одного или нескольких тегов, которые фильтруют, которые проверяют отображение на панели мониторинга.

Возвращаемое значение

Тело

Dashboard

Обновление переменной среды

Идентификатор операции:

PutV1VariablesKey

Обновляет переменную среды. Использует ключевое поле в качестве идентификатора для обновления. Обновляет только значение и заблокированное свойство.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Key	key	True	string	Ключ.
Key	key		string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.

Возвращаемое значение

Тело

EnvironmentVariable

Обновление периода обслуживания

Идентификатор операции:

PutV1MaintenancewindowsId

Обновляет период обслуживания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Имя	name	True	string	Имя периода обслуживания.
Список тегов окна обслуживания	tags		array of string	Имена периода обслуживания проверок и групп должны применяться.
Начинается с	startsAt	True	date	Дата начала периода обслуживания.
Заканчивается в	endsAt	True	date	Дата окончания периода обслуживания.
Интервал повторения	repeatInterval		number	Интервал повторения периода обслуживания из первого вхождения.
Единица повторения	repeatUnit	True	string	Стратегия повтора для периода обслуживания.
Повторение заканчивается в	repeatEndsAt		date	Дата окончания периода обслуживания, в которой должно перестать повторяться.

Возвращаемое значение

Тело

MaintenanceWindow

Обновление подписок канала оповещений

Идентификатор операции:

PutV1AlertchannelsIdSubscriptions

Обновите подписки канала оповещений. Используйте это, чтобы добавить проверку в канал оповещений, чтобы оповещения о сбоях и восстановлении отправлялись для этой проверки. Примечание. При передаче объекта подписки можно указать только checkId или groupId, а не оба.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Проверка идентификатора	checkId		guid	Вы можете передать checkId или groupId, но не оба.
Идентификатор группы	groupId		number	Вы можете передать checkId или groupId, но не оба.
Activated	activated	True	boolean	Активируется ли активация.

Возвращаемое значение

Тело

AlertChanelSubscription

Обновление проверки [УСТАРЕЛО]

Идентификатор операции:

PutV1ChecksId

[НЕ РЕКОМЕНДУЕТСЯ] Эта конечная точка будет удалена в понедельник 4 июля 2022 года. Используйте вместо этого PUT /checks/api/{id} или PUT /checks/browser/{id}. Обновляет новую проверку API или браузера.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name		string	Имя проверки.
Activated	activated		boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Тип проверки	checkType		string	Тип проверки.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Смещение частоты	frequencyOffset		integer	Используется для установки секунд для проверки частот в течение 1 минут (только для проверок API) и распространения проверок в течение 1 минуты. Это работает следующим образом: проверки с частотой 0 могут иметь частоту 10, 20 или 30 означает, что они будут выполняться каждые 10, 20 или 30 секунд. Проверки с частотой ниже и равным 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.floor(частота * 10), т. е. для проверки, которая выполняется каждые 5 минут, максимальная частотаOffset составляет 50. Проверки с частотой выше 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.ceil(частота / 60), т. е. для проверки, которая выполняется каждые 720 минут, максимальная частотаOffset составляет 12.
Проверка запроса	request	True	object	Запрос проверки.
Скрипт	script	True	string	Скрипт.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime		number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime		number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

Check

Обновление проверки API

Идентификатор операции:

PutV1ChecksApiId

Обновляет проверку API.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name		string	Имя проверки.
Activated	activated		boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
method	method	True	string
URL	url	True	string	URL-адрес.
Следуйте перенаправлениям	followRedirects		boolean	Следует ли следовать перенаправлениям.
Пропуск SSL	skipSSL		boolean	Следует ли пропускать SSL.
Тело	body		string	Тело.
Тип телосложения	bodyType		string	Тип тела.
Key	key	True	string	Ключ.
Ценность	value	True	string	Значение.
Заблокировано	locked		boolean	Заблокировано ли.
Исходный материал	source		string	Источник.
Недвижимость	property		string	Свойство.
Comparison	comparison		string	Сравнение.
Цель	target		string	Цель.
Имя пользователя	username	True	string	Имя пользователя.
Пароль	password	True	string	Пароль.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Смещение частоты	frequencyOffset		integer	Используется для установки секунд для проверки частот в течение 1 минут и распространения проверок в течение диапазона времени для частоты более 1 минуты. Это работает следующим образом: проверки с частотой 0 могут иметь частоту 10, 20 или 30 означает, что они будут выполняться каждые 10, 20 или 30 секунд. Проверки с частотой ниже и равным 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.floor(частота * 10), т. е. для проверки, которая выполняется каждые 5 минут, максимальная частотаOffset составляет 50. Проверки с частотой выше 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.ceil(частота / 60), т. е. для проверки, которая выполняется каждые 720 минут, максимальная частотаOffset составляет 12.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime		number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime		number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckAPI

Обновление проверки браузера

Идентификатор операции:

PutV1ChecksBrowserId

Обновляет проверку браузера.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name		string	Имя проверки.
Activated	activated		boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Скрипт	script		string	Допустимый фрагмент кода javascript Node.js, описывающий взаимодействие браузера с платформами Puppeteer или Playwright.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckBrowser

Обновление фрагмента кода

Идентификатор операции:

PutV1SnippetsId

Обновляет фрагмент кода.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Имя	name	True	string	Имя фрагмента кода.
Скрипт	script	True	string	Код Node.js, взаимодействующий со жизненным циклом проверки API, или функции в качестве частичного для проверок браузера.

Возвращаемое значение

Тело

Snippet

Обновление частного расположения

Идентификатор операции:

PutV1PrivatelocationsId

Обновляет частное расположение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Имя	name	True	string	Имя, назначенное частному расположению.
Icon	icon		string	Значок.

Возвращаемое значение

Тело

commonPrivateLocationSchemaResponse

Отображение сведений для одной конкретной среды выполнения

Идентификатор операции:

GetV1RuntimesId

Отображает сведения обо всех включенных пакетах NPM и их версии для одной конкретной среды выполнения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Возвращаемое значение

Тело

Runtime

Перечисление всех переменных среды

Идентификатор операции:

GetV1Variables

Перечисляет все текущие переменные среды в учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

EnvironmentVariableList

Перечисление всех проверок

Идентификатор операции:

GetV1Checks

Выводит список всех текущих проверок в вашей учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.
Фильтр URL-адреса проверки API	apiCheckUrlFilterPattern		string	Фильтрует результаты по строке, содержащейся в URL-адресе проверки API, например домену, например www.myapp.com. Возвращает только проверки API.

Возвращаемое значение

Товары

CheckList

Перечисление всех фрагментов

Идентификатор операции:

GetV1Snippets

Выводит список всех текущих фрагментов в вашей учетной записи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

SnippetList

Получение всех проверок в определенной группе с примененными параметрами группы

Идентификатор операции:

GetV1CheckgroupsIdChecks

Выводит список всех проверок в определенной группе проверки с примененными параметрами группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.

Возвращаемое значение

Товары

Model8

Получение группы проверки

Идентификатор операции:

GetV1CheckgroupsId

Отображение сведений о определенной группе проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Тело

CheckGroup

Получение значка состояния группы

Идентификатор операции:

GetV1BadgesGroupsGroupid

Получение индикатора состояния группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupId	True	integer	Идентификатор группы.
Style	style		string	Стиль.
Тема	theme		string	Тема.
Время ответа	responseTime		boolean	Время отклика.

Возвращаемое значение

response

string

Получение значка состояния проверки

Идентификатор операции:

GetV1BadgesChecksCheckid

Получение индикатора состояния проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.
Style	style		string	Стиль.
Тема	theme		string	Тема.
Время ответа	responseTime		boolean	Время отклика.

Возвращаемое значение

response

string

Получение канала оповещений

Идентификатор операции:

GetV1AlertchannelsId

Отображение сведений о определенном канале оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Тело

AlertChannel

Получение метрик работоспособности частного расположения из периода времени

Идентификатор операции:

GetV1PrivatelocationsIdMetrics

Получение метрик работоспособности частного расположения из периода времени.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
От	from	True	date	Выберите метрики, начиная с этой метки времени UNIX. Должно быть меньше 15 дней назад.
Кому	to	True	date	Выберите метрики до этой метки времени UNIX.

Возвращаемое значение

Тело

privateLocationsMetricsHistoryResponseSchema

Получение одной проверки в определенной группе с примененными параметрами группы

Идентификатор операции:

GetV1CheckgroupsGroupidChecksCheckid

Отображение сведений о одной проверке определенной группы проверки с примененными параметрами группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupId	True	integer	Идентификатор группы.
Проверка идентификатора	checkId	True	string	Идентификатор проверки.

Возвращаемое значение

Тело

CheckGroupCheck

Получение переменной среды

Идентификатор операции:

GetV1VariablesKey

Отображение сведений о конкретной переменной среды. Использует ключевое поле для выбора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Key	key	True	string	Ключ.

Возвращаемое значение

Тело

EnvironmentVariable

Получение периода обслуживания

Идентификатор операции:

GetV1MaintenancewindowsId

Отображение сведений о определенном окне обслуживания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Тело

MaintenanceWindow

Получение проверки

Идентификатор операции:

GetV1ChecksId

Отображение сведений о конкретном API или проверке браузера.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Возвращаемое значение

Тело

Check

Получение результата проверки

Идентификатор операции:

GetV1CheckresultsCheckidCheckresultid

Отображение сведений о конкретном результате проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.
Проверка идентификатора результата	checkResultId	True	string	Идентификатор результата проверки.

Возвращаемое значение

Тело

CheckResult

Получение сведений о состоянии проверки

Идентификатор операции:

GetV1CheckstatusesCheckid

Отображение текущих сведений о состоянии для определенной проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.

Возвращаемое значение

Тело

CheckStatus

Получение триггера группы проверки

Идентификатор операции:

GetV1TriggersCheckgroupsGroupid

Находит триггер группы проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupId	True	integer	Идентификатор группы.

Возвращаемое значение

Тело

CheckGroupTrigger

Получение триггера проверки

Идентификатор операции:

GetV1TriggersChecksCheckid

Находит триггер проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.

Возвращаемое значение

Тело

CheckTrigger

Получение фрагмента кода

Идентификатор операции:

GetV1SnippetsId

Отображение сведений о конкретном фрагменте кода.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Возвращаемое значение

Тело

Snippet

Получение частного расположения

Идентификатор операции:

GetV1PrivatelocationsId

Отображение сведений о конкретном частном расположении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Возвращаемое значение

Тело

privatelocationschema

Создает настраиваемый отчет для всех метрик проверки браузера

Идентификатор операции:

GetV2ReportingBrowserchecksId

Создает отчет с агрегированной или не агрегированной статистикой для определенного периода времени проверки браузера.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
От	from		date	Настраиваемое время начала окна отчетности в формате метки времени unix. Настройка пользовательской метки времени переопределяет использование любого предустановленногоWindow.
Кому	to		date	Настраиваемое время окончания окна отчетности в формате метки времени unix. Настройка пользовательской метки времени переопределяет использование любого предустановленногоWindow.
Окно предустановки	presetWindow		string	Предустановленные окна отчетов используются для быстрого создания отчета в часто используемых окнах. Можно переопределить с помощью пользовательской метки времени и из нее.
Интервал агрегирования	aggregationInterval		number	Интервал времени, используемый для агрегирования метрик в минутах. Например, пять минут составляет 300, 24 часа — 1440.
Группировать по	groupBy		string	Определяет группирование данных ряда.
Фильтрация по состоянию	filterByStatus		array	Используйте состояние для фильтрации для проверки неудачных или успешных данных результатов проверки.
Metrics	metrics		array	Параметры метрик для проверок браузера.

Возвращаемое значение

Атрибуты.

Attributes

object

Создает отчет с статистической статистикой для проверок и проверок групп

Идентификатор операции:

GetV1Reporting

Создает отчет с агрегированной статистикой для всех проверок или отфильтрованного набора проверок в течение указанного периода времени.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
От	from		date	Настраиваемое время начала окна отчетности в формате метки времени unix. Настройка пользовательской метки времени переопределяет использование любого предустановленногоWindow.
Кому	to		date	Настраиваемое время окончания окна отчетности в формате метки времени unix. Настройка пользовательской метки времени переопределяет использование любого предустановленногоWindow.
Окно предустановки	presetWindow		string	Предустановленные окна отчетов используются для быстрого создания отчета в часто используемых окнах. Можно переопределить с помощью пользовательской метки времени и из нее.
Фильтрация по тегам	filterByTags		array	Используйте теги для фильтрации проверок, которые нужно просмотреть в отчете.
Деактивировано	deactivated		boolean	Фильтрация по активированным состояниям.

Возвращаемое значение

Товары

ReportingList

Создание группы проверки

Идентификатор операции:

PostV1Checkgroups

Создает новую группу проверки. Вы можете добавить проверки в группу, задав свойство groupId отдельных проверок.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name	True	string	Имя группы проверки.
Activated	activated		boolean	Определяет, выполняются ли проверки в группе.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки в этой группе и (или) восстановления.
Проверка списка тегов группы	tags		array of string	Теги для организации и фильтрации проверок.
Проверка списка расположений группы	locations		array of string	Массив одного или нескольких расположений центра обработки данных для выполнения проверок.
Concurrency	concurrency		number	Определяет, сколько проверок вызывается одновременно при активации группы проверки из CI/CD или через API.
URL	url		string	Базовый URL-адрес для этой группы, на который можно ссылаться с переменной {{GROUP_BASE_URL}}} во всех проверках группы.
Key	key	True	string	Ключ.
Ценность	value	True	string	Значение.
Заблокировано	locked		boolean	Заблокировано ли.
Исходный материал	source		string	Источник.
Недвижимость	property		string	Свойство.
Comparison	comparison		string	Сравнение.
Цель	target		string	Цель.
Имя пользователя	username	True	string	Имя пользователя.
Пароль	password	True	string	Пароль.
Проверка по умолчанию проверки группы создания браузера	browserCheckDefaults		object	Группа проверки создает параметры браузера по умолчанию.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения проверок в этой группе.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой группе проверки.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API в этой группе.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, который будет использоваться на этапе отлезения проверки API в этой группе.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для запуска на этапе установки проверки API в этой группе.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе отлезения проверки API в этой группе.
Проверка частных расположений	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckGroup

Создание канала оповещений

Идентификатор операции:

PostV1Alertchannels

Создает новый канал генерации оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id		number	Идентификатор.
Проверка идентификатора	checkId		guid	Идентификатор проверки.
Идентификатор группы	groupId		number	Идентификатор группы.
Activated	activated	True	boolean	Активируется ли активация.
Тип	type	True	string	Тип.
Создание конфигурации канала оповещений	config	True	object	Канал оповещений создает конфигурацию.
Отправка восстановления	sendRecovery		boolean	Указывает, отправляется ли восстановление.
Сбой отправки	sendFailure		boolean	Указывает, сбой отправки.
Отправка с пониженным состоянием	sendDegraded		boolean	Состояние отправки ухудшается.
Срок действия SSL	sslExpiry		boolean	Определяет, следует ли отправлять оповещение для истечения срока действия SSL-сертификатов.
Пороговое значение истечения срока действия SSL	sslExpiryThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.

Возвращаемое значение

Тело

AlertChannel

Создание нового ключа API для частного расположения

Идентификатор операции:

PostV1PrivatelocationsIdKeys

Создает ключ API в частном расположении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Возвращаемое значение

Тело

privateLocationKeys

Создание панели мониторинга

Идентификатор операции:

PostV1Dashboards

Создает новую панель мониторинга. Возвращает значение 409 при попытке создать панель мониторинга с пользовательским URL-адресом или пользовательским доменом, который уже взят.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Пользовательский URL-адрес	customUrl		string	Имя поддомена в checklyhq.com. Необходимо быть уникальным для всех пользователей.
Личный домен	customDomain		string	Личный домен пользователя, например status.example.com. Ознакомьтесь с документацией по обновлению использования DNS и SSL.
Logo	logo		string	URL-адрес, указывающий на файл изображения.
Favicon	favicon		string	URL-адрес, указывающий на файл изображения, используемый в качестве панели мониторинга favicon.
Link	link		string	Ссылка URL-адреса для перенаправления при нажатии логотипа панели мониторинга.
Header	header		string	Часть текста, отображаемая в верхней части панели мониторинга.
Description	description		string	Фрагмент текста, отображаемый под заголовком или заголовком панели мониторинга.
Ширина	width		string	Определяет, следует ли использовать весь экран или фокус в центре.
Частота обновления	refreshRate		number	Как часто обновлять панель мониторинга в секундах.
Нумеровать страницы	paginate		boolean	Определяет включение или отключение разбиения на страницы.
Скорость разбиения на страницы	paginationRate		number	Как часто запускать разбиение на страницы в секундах.
Проверка на страницу	checksPerPage		number	Количество проверок, отображаемых на странице.
Использование и оператор	useTagsAndOperator		boolean	Когда следует использовать оператор AND для поиска тегов.
Скрытие тегов	hideTags		boolean	Отображение или скрытие тегов на панели мониторинга.
Список тегов панели мониторинга	tags		array of string	Список одного или нескольких тегов, которые фильтруют, которые проверяют отображение на панели мониторинга.

Возвращаемое значение

Тело

Dashboard

Создание переменной среды

Идентификатор операции:

PostV1Variables

Создает новую переменную среды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.

Возвращаемое значение

Тело

EnvironmentVariable

Создание периода обслуживания

Идентификатор операции:

PostV1Maintenancewindows

Создает новое окно обслуживания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя периода обслуживания.
Список тегов окна обслуживания	tags		array of string	Имена периода обслуживания проверок и групп должны применяться.
Начинается с	startsAt	True	date	Дата начала периода обслуживания.
Заканчивается в	endsAt	True	date	Дата окончания периода обслуживания.
Интервал повторения	repeatInterval		number	Интервал повторения периода обслуживания из первого вхождения.
Единица повторения	repeatUnit	True	string	Стратегия повтора для периода обслуживания.
Повторение заканчивается в	repeatEndsAt		date	Дата окончания периода обслуживания, в которой должно перестать повторяться.

Возвращаемое значение

Тело

MaintenanceWindow

Создание проверки [УСТАРЕЛО]

Идентификатор операции:

PostV1Checks

[НЕ РЕКОМЕНДУЕТСЯ] Эта конечная точка будет удалена в понедельник 4 июля 2022 года. Используйте вместо этого POST /checks/api или POST /checks/browser. Создает новую проверку API или браузера. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingsможет alertSettings быть null

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name	True	string	Имя проверки.
Activated	activated	True	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Тип проверки	checkType	True	string	Тип проверки.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Смещение частоты	frequencyOffset		integer	Используется для установки секунд для проверки частот в течение 1 минут (только для проверок API) и распространения проверок в течение 1 минуты. Это работает следующим образом: проверки с частотой 0 могут иметь частоту 10, 20 или 30 означает, что они будут выполняться каждые 10, 20 или 30 секунд. Проверки с частотой ниже и равным 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.floor(частота * 10), т. е. для проверки, которая выполняется каждые 5 минут, максимальная частотаOffset составляет 50. Проверки с частотой выше 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.ceil(частота / 60), т. е. для проверки, которая выполняется каждые 720 минут, максимальная частотаOffset составляет 12.
Проверка запроса	request		object	Запрос проверки.
Скрипт	script	True	string	Скрипт.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime		number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime		number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

Check

Создание проверки API

Идентификатор операции:

PostV1ChecksApi

Создает новую проверку API. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingможет alertSetting быть null

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name	True	string	Имя проверки.
Activated	activated	True	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
method	method	True	string
URL	url	True	string	URL-адрес.
Следуйте перенаправлениям	followRedirects		boolean	Следует ли выполнять перенаправления.
Пропуск SSL	skipSSL		boolean	Следует ли пропускать SSL.
Тело	body		string	Тело.
bodyType	bodyType		string
Key	key	True	string	Ключ.
Ценность	value	True	string	Значение.
Заблокировано	locked		boolean	Заблокировано ли.
Исходный материал	source		string	Источник.
Недвижимость	property		string	Свойство.
Comparison	comparison		string	Сравнение.
Цель	target		string	Цель.
Имя пользователя	username	True	string	Имя пользователя.
Пароль	password	True	string	Пароль.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Идентификатор фрагмента слома	tearDownSnippetId		number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Идентификатор фрагмента программы установки	setupSnippetId		number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Смещение частоты	frequencyOffset		integer	Используется для установки секунд для проверки частот в течение 1 минут и распространения проверок в течение диапазона времени для частоты более 1 минуты. Это работает следующим образом: проверки с частотой 0 могут иметь частоту 10, 20 или 30 означает, что они будут выполняться каждые 10, 20 или 30 секунд. Проверки с частотой ниже и равным 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.floor(частота * 10), т. е. для проверки, которая выполняется каждые 5 минут, максимальная частотаOffset составляет 50. Проверки с частотой выше 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.ceil(частота / 60), т. е. для проверки, которая выполняется каждые 720 минут, максимальная частотаOffset составляет 12.
Локальный скрипт установки	localSetupScript		string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript		string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime		number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime		number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckAPI

Создание проверки браузера

Идентификатор операции:

PostV1ChecksBrowser

Создает новую проверку браузера. Возвращается 402 , когда вы превышаете предел вашего плана. При использовании globalAlertSettingможет alertSetting быть null

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Автоматическое назначение оповещений	autoAssignAlerts		boolean	Определяет, будет ли автоматически добавлена новая проверка в качестве подписчика во все существующие каналы оповещений при создании.
Имя	name	True	string	Имя проверки.
Activated	activated	True	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted		boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck		boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail		boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations		array of string	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags		array of string	Теги для организации и фильтрации проверок.
Тип эскалации	escalationType		string	Определяет тип эскалации, используемый.
Пороговое значение неудачного запуска	failedRunThreshold		number	После того, сколько неудачных проверок выполняется уведомление об оповещении.
Пороговое значение сбоя в минутах	minutesFailingThreshold		number	Через сколько минут после проверки начинает отправляться оповещение.
Сумма	amount		number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval		number	Через какой интервал должны отправляться напоминания.
Включен	enabled		boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold		integer	В какой момент времени начать оповещение о SSL-сертификатах.
Использование глобальных параметров оповещений	useGlobalAlertSettings		boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId		number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder		number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId		string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
Идентификатор канала оповещений	alertChannelId	True	number	Идентификатор канала оповещений.
Activated	activated	True	boolean	Активируется ли активация.
Key	key	True	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	True	string	Значение переменной среды.
Заблокировано	locked		boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.
Частота	frequency		integer	Как часто проверка должна выполняться в минутах.
Скрипт	script	True	string	Допустимый фрагмент кода javascript Node.js, описывающий взаимодействие браузера с платформами Puppeteer или Playwright.
Частные расположения	privateLocations		array of string	Массив одного или нескольких частных расположений, где выполняется проверка.

Возвращаемое значение

Тело

CheckBrowser

Создание триггера группы проверки

Идентификатор операции:

PostV1TriggersCheckgroupsGroupid

Создает триггер группы проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupId	True	integer	Идентификатор группы.

Возвращаемое значение

Тело

CheckGroupTrigger

Создание триггера проверки

Идентификатор операции:

PostV1TriggersChecksCheckid

Создает триггер проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.

Возвращаемое значение

Тело

CheckTrigger

Создание фрагмента кода

Идентификатор операции:

PostV1Snippets

Создает новый фрагмент кода.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя фрагмента кода.
Скрипт	script	True	string	Код Node.js, взаимодействующий со жизненным циклом проверки API, или функции в качестве частичного для проверок браузера.

Возвращаемое значение

Тело

Snippet

Создание частного расположения

Идентификатор операции:

PostV1Privatelocations

Создает новое частное расположение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя, назначенное частному расположению.
Имя slug	slugName	True	string	Допустимое имя slug.
Icon	icon		string	Значок.

Возвращаемое значение

Тело

commonPrivateLocationSchemaResponse

Список всех поддерживаемых расположений

Идентификатор операции:

GetV1Locations

Выводит список всех поддерживаемых расположений.

Возвращаемое значение

Товары

LocationList

Список всех поддерживаемых сред выполнения

Идентификатор операции:

GetV1Runtimes

Перечисляет все поддерживаемые среды выполнения и включенные пакеты NPM для проверок браузера и настройки и слезоточивых сценариев для проверок API.

Возвращаемое значение

Товары

RuntimeList

Список всех результатов проверки

Идентификатор операции:

GetV1CheckresultsCheckid

Выводит полные необработанные результаты проверки для определенной проверки. Мы сохраняем необработанные результаты в течение 30 дней. Через 30 дней они удаляются. Однако мы сохраняем свернутые результаты на неопределенный период. Вы можете фильтровать по типу проверки и типу результатов, чтобы сузить список. to Используйте параметры для from указания диапазона дат (метка времени UNIX в секундах). В зависимости от типа проверки некоторые поля могут иметь значение NULL. Эта конечная точка вернет данные в течение шести часов. Если задано значение от и до парам, они должны быть не более шести часов. Если ни один из них не задан, мы рассмотрим парам, чтобы быть сейчас и от param быть шесть часов ранее. Если задано значение только для параметра, то мы задали значение от шести часов раньше. Напротив, если только от парама задано, мы рассмотрим парам, чтобы быть шесть часов спустя. Ограничение скорости применяется к этой конечной точке, вы можете отправлять 5 запросов / 10 секунд в большей степени.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.
Лимит	limit		integer	Ограничение количества результатов.
Number	page		number	Номер страницы.
От	from		date	Выберите документы из этой метки времени UNIX (>= дата). По умолчанию — 6 часов.
Кому	to		date	Выберите оповещения до этой метки времени UNIX (< дата). Значение по умолчанию — 6 часов после этого.
Местоположение	location		string	Укажите расположение центра обработки данных, например eu-west-1 для фильтрации по расположению
Тип проверки	checkType		string	Тип проверки.
Имеет сбои	hasFailures		boolean	Результат проверки имеет один или несколько сбоев.

Возвращаемое значение

Товары

CheckResultList

Удаление группы проверки

Идентификатор операции:

DeleteV1CheckgroupsId

Окончательно удаляет группу проверок. Невозможно удалить группу проверки, если она по-прежнему содержит проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Удаление канала оповещений

Идентификатор операции:

DeleteV1AlertchannelsId

Окончательно удаляет канал генерации оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Удаление панели мониторинга

Идентификатор операции:

DeleteV1DashboardsDashboardid

Окончательно удаляет панель мониторинга.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	dashboardId	True	string	Идентификатор панели мониторинга.

Удаление переменной среды

Идентификатор операции:

DeleteV1VariablesKey

Окончательно удаляет переменную среды. Использует поле ключа в качестве идентификатора для удаления.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Key	key	True	string	Ключ.

Удаление периода обслуживания

Идентификатор операции:

DeleteV1MaintenancewindowsId

Окончательно удаляет период обслуживания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Удаление проверки

Идентификатор операции:

DeleteV1ChecksId

Окончательно удаляет проверку API или браузера и все связанные с ней данные о состоянии и результатах.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Удаление существующего ключа API для частного расположения

Идентификатор операции:

DeleteV1PrivatelocationsIdKeysKeyid

Окончательно удаляет ключ API из частного расположения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.
Идентификатор ключа	keyId	True	string	Идентификатор ключа.

Удаление триггера группы проверки

Идентификатор операции:

DeleteV1TriggersCheckgroupsGroupid

Удаляет триггер групп проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupId	True	integer	Идентификатор группы.

Удаление триггера проверки

Идентификатор операции:

DeleteV1TriggersChecksCheckid

Удаляет триггер проверки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Проверка идентификатора	checkId	True	string	Идентификатор проверки.

Удаление фрагмента кода

Идентификатор операции:

DeleteV1SnippetsId

Окончательно удаляет фрагмент кода.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	integer	Идентификатор.

Удаление частного расположения

Идентификатор операции:

DeleteV1PrivatelocationsId

Окончательно удаляет частное расположение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор.

Определения

AlertChannelConfig

Конфигурация канала оповещений.

Имя	Путь	Тип	Описание
Настройка канала оповещений		object	Конфигурация канала оповещений.

AlertChanelSubscription

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Проверка идентификатора	checkId	guid	Идентификатор проверки.
Идентификатор группы	groupId	number	Идентификатор группы.
Activated	activated	boolean	Активируется ли активация.

AlertChanelSubscriptionList

Все проверки, подписанные на этот канал.

Имя	Путь	Тип	Описание
Товары		AlertChanelSubscription

AlertChannel

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Тип	type	string	Тип канала оповещений, например EMAIL или SLACK.
Настройка канала оповещений	config	AlertChannelConfig	Конфигурация канала оповещений.
Список подписок канала оповещений	subscriptions	AlertChanelSubscriptionList	Все проверки, подписанные на этот канал.
Отправка восстановления	sendRecovery	boolean	Указывает, отправляется ли восстановление.
Сбой отправки	sendFailure	boolean	Указывает, сбой отправки.
Отправка с пониженным состоянием	sendDegraded	boolean	Состояние отправки ухудшается.
Срок действия SSL	sslExpiry	boolean	Определяет, следует ли отправлять оповещение для истечения срока действия SSL-сертификатов.
Пороговое значение истечения срока действия SSL	sslExpiryThreshold	integer	В какой момент времени начать оповещение о SSL-сертификатах.
Создано в	created_at	date-time	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

AlertChannelList

Имя	Путь	Тип	Описание
Товары		AlertChannel

CheckAlert

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор этого оповещения.
Имя	name	string	Имя проверки.
Проверка идентификатора	checkId	string	Идентификатор проверки этого оповещения принадлежит.
Тип оповещения	alertType	string	Тип оповещения.
Тип проверки	checkType	string	Тип проверки.
Расположение запуска	runLocation	string	Из какого расположения центра обработки данных активируется оповещение проверки.
Время ответа	responseTime	number	Описывает время выполнения соответствующих частей этой проверки. Любое время системы таймера установки, необходимое для запуска этой проверки в серверной части Checkly, не является частью этого.
Ошибка	error	string	Все сообщения об ошибках, которые были частью ошибки проверки, активируя оповещение.
Код состояния	statusCode	string	Код состояния ответа. Применяется только к проверкам API.
Создано в	created_at	date	Дата и время создания оповещения проверки.
Начало работы	startedAt	date	Дата и время запуска оповещения проверки.

CheckAlertList

Имя	Путь	Тип	Описание
Товары		CheckAlert

CheckGroupTagList

Теги для организации и фильтрации проверок.

Имя	Путь	Тип	Описание
Товары		string

CheckGroupLocationList

Массив одного или нескольких расположений центра обработки данных для выполнения проверок.

Имя	Путь	Тип	Описание
Товары		string

KeyValue

Имя	Путь	Тип	Описание
Key	key	string	Ключ.
Ценность	value	string	Значение.
Заблокировано	locked	boolean	Заблокировано ли.

HeaderList

Имя	Путь	Тип	Описание
Товары		KeyValue

QueryParameterList

Имя	Путь	Тип	Описание
Товары		KeyValue

Утверждение

Имя	Путь	Тип	Описание
Исходный материал	source	string	Источник.
Недвижимость	property	string	Свойство.
Comparison	comparison	string	Сравнение.
Цель	target	string	Цель.

Проверочные списки

Ознакомьтесь с основной документацией по проверке утверждений для определенных значений, таких как регулярные выражения и дескрипторы пути JSON, которые можно использовать в поле свойства.

Имя	Путь	Тип	Описание
Товары		Assertion

BasicAuth

Имя	Путь	Тип	Описание
Имя пользователя	username	string	Имя пользователя.
Пароль	password	string	Пароль.

CheckGroupAPICheckDefaults

Имя	Путь	Тип	Описание
URL	url	string	Базовый URL-адрес для этой группы, на который можно ссылаться с переменной {{GROUP_BASE_URL}}} во всех проверках группы.
headers	headers	HeaderList
queryParameters	queryParameters	QueryParameterList
Список утверждений	assertions	AssertionList	Ознакомьтесь с основной документацией по проверке утверждений для определенных значений, таких как регулярные выражения и дескрипторы пути JSON, которые можно использовать в поле свойства.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

По умолчанию проверяется браузер группы проверки.

Имя	Путь	Тип	Описание
Проверка значений по умолчанию в браузере группы		object	По умолчанию проверяется браузер группы проверки.

EnvironmentVariable

Имя	Путь	Тип	Описание
Key	key	string	Ключ переменной среды (это значение не может быть изменено).
Ценность	value	string	Значение переменной среды.
Заблокировано	locked	boolean	Используется только в пользовательском интерфейсе для скрытия значения, например пароля.

EnvironmentVariableList

Имя	Путь	Тип	Описание
Товары		EnvironmentVariable

AlertSettingsRunBasedEscalation

Имя	Путь	Тип	Описание
Пороговое значение неудачного запуска	failedRunThreshold	number	После того, сколько неудачных проверок выполняется уведомление об оповещении.

AlertSettingsTimeBasedEscalation

Имя	Путь	Тип	Описание
Пороговое значение сбоя в минутах	minutesFailingThreshold	number	Через сколько минут после проверки начинает отправляться оповещение.

AlertSettingsReminders

Имя	Путь	Тип	Описание
Сумма	amount	number	Сколько напоминаний отправляется после первоначального уведомления об оповещении.
Интервал	interval	number	Через какой интервал должны отправляться напоминания.

AlertSettingsSSLCertificates

[НЕ РЕКОМЕНДУЕТСЯ] sslCertificates не рекомендуется и больше не используется. Пропустить его, будет удалена в будущей версии.

Имя	Путь	Тип	Описание
Включен	enabled	boolean	Определяет, следует ли отправлять уведомления оповещений для истечения срока действия SSL-сертификатов.
Пороговое значение оповещения	alertThreshold	integer	В какой момент времени начать оповещение о SSL-сертификатах.

CheckGroupAlertSettings

Параметры оповещений.

Имя	Путь	Тип	Описание
Тип эскалации	escalationType	string	Определяет тип эскалации, используемый.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Напоминания	reminders	AlertSettingsReminders
Параметры оповещений SSL-сертификатов	sslCertificates	AlertSettingsSSLCertificates	[НЕ РЕКОМЕНДУЕТСЯ] sslCertificates не рекомендуется и больше не используется. Пропустить его, будет удалена в будущей версии.

Model1

Подписка канала оповещений.

Имя	Путь	Тип	Описание
Идентификатор канала оповещений	alertChannelId	number	Идентификатор канала оповещений.
Activated	activated	boolean	Активируется ли активация.

AlertChannelSubscriptionCreateList

Список подписок канала генерации оповещений.

Имя	Путь	Тип	Описание
Подписка канала оповещений		Model1	Подписка канала оповещений.

privateLocations

Массив одного или нескольких частных расположений, где выполняется проверка.

Имя	Путь	Тип	Описание
Товары		string

CheckGroup

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Имя	name	string	Имя группы проверки.
Activated	activated	boolean	Определяет, выполняются ли проверки в группе.
Приглушенный	muted	boolean	Определяет, будут ли уведомления отправляться при сбое проверки в этой группе и (или) восстановления.
Проверка списка тегов группы	tags	CheckGroupTagList	Теги для организации и фильтрации проверок.
Проверка списка расположений группы	locations	CheckGroupLocationList	Массив одного или нескольких расположений центра обработки данных для выполнения проверок.
Concurrency	concurrency	number	Определяет, сколько проверок вызывается одновременно при активации группы проверки из CI/CD или через API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Проверка значений по умолчанию в браузере группы	browserCheckDefaults	CheckGroupBrowserCheckDefaults	По умолчанию проверяется браузер группы проверки.
environmentVariables	environmentVariables	EnvironmentVariableList
Двойная проверка	doubleCheck	boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Использование глобальных параметров оповещений	useGlobalAlertSettings	boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой группе проверки.
Проверка параметров оповещений группы	alertSettings	CheckGroupAlertSettings	Параметры оповещений.
Список создания подписки канала оповещений	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Список подписок канала генерации оповещений.
Идентификатор фрагмента программы установки	setupSnippetId	number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API в этой группе.
Идентификатор фрагмента слома	tearDownSnippetId	number	Ссылка на идентификатор фрагмента кода, который будет использоваться на этапе отлезения проверки API в этой группе.
Локальный скрипт установки	localSetupScript	string	Допустимый фрагмент кода Node.js для запуска на этапе установки проверки API в этой группе.
Локальный скрипт слома	localTearDownScript	string	Допустимый фрагмент кода Node.js, выполняемый на этапе отлезения проверки API в этой группе.
Идентификатор среды выполнения	runtimeId	string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения проверок в этой группе.
Частные расположения	privateLocations	privateLocations	Массив одного или нескольких частных расположений, где выполняется проверка.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

CheckGroupList

Имя	Путь	Тип	Описание
Товары		CheckGroup

CheckLocationList

Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.

Имя	Путь	Тип	Описание
Товары		string

CheckTagList

Теги для организации и фильтрации проверок.

Имя	Путь	Тип	Описание
Товары		string

CheckAlertSettings

Параметры оповещений.

Имя	Путь	Тип	Описание
Тип эскалации	escalationType	string	Определяет тип эскалации, используемый.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Напоминания	reminders	AlertSettingsReminders
Параметры оповещений SSL-сертификатов	sslCertificates	AlertSettingsSSLCertificates	[НЕ РЕКОМЕНДУЕТСЯ] sslCertificates не рекомендуется и больше не используется. Пропустить его, будет удалена в будущей версии.

CheckAlertChannelSubscription

Имя	Путь	Тип	Описание
Идентификатор канала оповещений	alertChannelId	number	Идентификатор канала оповещений.
Activated	activated	boolean	Активируется ли активация.

CheckAlertChannelSubscriptionList

Имя	Путь	Тип	Описание
Товары		CheckAlertChannelSubscription

CheckRequest

Запрос проверки.

Имя	Путь	Тип	Описание
Проверка запроса		object	Запрос проверки.

CheckEnvironmentVariableList

Пары "ключ-значение" для задания переменных среды во время проверки. Это относится только к проверкам браузера. По возможности используйте глобальные переменные среды.

Имя	Путь	Тип	Описание
Товары		EnvironmentVariable

CheckAlertEmail

Имя	Путь	Тип	Описание
Address	address	string	Адрес.

CheckAlertEmailList

Имя	Путь	Тип	Описание
Товары		CheckAlertEmail

Model4

Имя	Путь	Тип	Описание
Товары		KeyValue

Model5

Имя	Путь	Тип	Описание
Товары		KeyValue

CheckAlertWebhook

Имя	Путь	Тип	Описание
Имя	name	string	Имя.
URL	url	string	URL-адрес.
Метод	method	string	Метод.
headers	headers	Model4
queryParameters	queryParameters	Model5

CheckAlertWebhookList

Имя	Путь	Тип	Описание
Товары		CheckAlertWebhook

CheckAlertSlack

Имя	Путь	Тип	Описание
URL	url	string	URL-адрес.

CheckAlertSlackList

Имя	Путь	Тип	Описание
Товары		CheckAlertSlack

CheckAlertSMS

Имя	Путь	Тип	Описание
Number	number	string	Число.
Имя	name	string	Имя.

CheckAlertSMSList

Имя	Путь	Тип	Описание
Товары		CheckAlertSMS

CheckAlertChannels

Имя	Путь	Тип	Описание
электронная почта	email	CheckAlertEmailList
веб-перехватчик	webhook	CheckAlertWebhookList
вялый	slack	CheckAlertSlackList
СМС	sms	CheckAlertSMSList

CheckGroupCheck

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя проверки.
Activated	activated	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted	boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck	boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail	boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations	CheckLocationList	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags	CheckTagList	Теги для организации и фильтрации проверок.
Проверка параметров оповещений	alertSettings	CheckAlertSettings	Параметры оповещений.
Использование глобальных параметров оповещений	useGlobalAlertSettings	boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId	number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder	number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId	string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Тип проверки	checkType	string	Тип проверки.
Частота	frequency	integer	Как часто проверка должна выполняться в минутах.
Смещение частоты	frequencyOffset	integer	Смещение частоты.
Проверка запроса	request	CheckRequest	Запрос проверки.
Скрипт	script	string	Скрипт.
Проверка списка переменных среды	environmentVariables	CheckEnvironmentVariableList	Пары "ключ-значение" для задания переменных среды во время проверки. Это относится только к проверкам браузера. По возможности используйте глобальные переменные среды.
Идентификатор фрагмента программы установки	setupSnippetId	number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Идентификатор фрагмента слома	tearDownSnippetId	number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Локальный скрипт установки	localSetupScript	string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript	string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime	number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime	number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
alertChannels	alertChannels	CheckAlertChannels
Частные расположения	privateLocations	privateLocations	Массив одного или нескольких частных расположений, где выполняется проверка.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

Model8

Имя	Путь	Тип	Описание
Товары		CheckGroupCheck

Утверждения

Список проверок API.

Имя	Путь	Тип	Описание
Товары		string

headers

Заголовки.

Имя	Путь	Тип	Описание
Headers		object	Заголовки.

params

Параметры.

Имя	Путь	Тип	Описание
Парамс		object	Параметры.

request

Запрос API.

Имя	Путь	Тип	Описание
method	method	string
URL-адрес	url	string
данные	data	string
Headers	headers	headers	Заголовки.
Парамс	params	params	Параметры.

Таймингов

Сроки.

Имя	Путь	Тип	Описание
Таймингов		object	Сроки.

временные фазы

Этапы времени.

Имя	Путь	Тип	Описание
Этапы времени		object	Этапы времени.

response

Ответ API.

Имя	Путь	Тип	Описание
Состояние	status	number	Состояние.
Текст состояния	statusText	string	Текст состояния.
Тело	body	string	Тело.
Headers	headers	headers	Заголовки.
Таймингов	timings	timings	Сроки.
Этапы времени	timingPhases	timingPhases	Этапы времени.

jobLog

Журнал заданий.

Имя	Путь	Тип	Описание
Журнал заданий		object	Журнал заданий.

jobAssets

Ресурсы, созданные из выполнения проверки.

Имя	Путь	Тип	Описание
Товары		string

CheckResultAPI

Данные ответа для проверки API.

Имя	Путь	Тип	Описание
Assertions	assertions	assertions	Список проверок API.
Просьба	request	request	Запрос API.
Ответ	response	response	Ответ API.
Ошибка запроса	requestError	string	Описывает, произошла ли ошибка в запросе.
Журнал заданий	jobLog	jobLog	Журнал заданий.
Ресурсы заданий	jobAssets	jobAssets	Ресурсы, созданные из выполнения проверки.

Ошибки

Список ошибок при выполнении проверки.

Имя	Путь	Тип	Описание
Товары		string

Model9

Проверьте результаты журнала выполнения.

Имя	Путь	Тип	Описание
Товары		string

traceSummary

Сводка трассировки.

Имя	Путь	Тип	Описание
Сводка трассировки		object	Сводка трассировки.

pages

Список страниц, используемых при выполнении проверки.

Имя	Путь	Тип	Описание
Товары		string

CheckResultBrowser

Данные ответа для проверки браузера.

Имя	Путь	Тип	Описание
Тип	type	string	Тип платформы, используемой проверкой.
Errors	errors	errors	Список ошибок при выполнении проверки.
Время окончания	endTime	number	Время окончания выполнения проверки.
Время начала	startTime	number	Время начала выполнения проверки.
Версия среды выполнения	runtimeVersion	string	Активная версия среды выполнения.
Проверка журнала выполнения	jobLog	Model9	Проверьте результаты журнала выполнения.
Ресурсы заданий	jobAssets	jobAssets	Ресурсы, созданные из выполнения проверки.
Сводка трассировки	traceSummary	traceSummary	Сводка трассировки.
Страницы	pages	pages	Список страниц, используемых при выполнении проверки.

CheckResult

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор этого результата.
Имя	name	string	Имя проверки.
Проверка идентификатора	checkId	string	Идентификатор проверки.
Имеет сбои	hasFailures	boolean	Описывает, произошел ли какой-либо сбой во время выполнения этой проверки. Это должно быть основное внимание для оценки поведения API или браузера. Утверждения, которые завершаются ошибкой, истечением времени ожидания или сбоем скриптов, разрешаются для этого значения.
Имеет ошибки	hasErrors	boolean	Описывает, произошла ли внутренняя ошибка в серверной части Checkly. Это должно быть ложно почти во всех случаях.
Деградируется	isDegraded	boolean	Проверка снижается, если она превышает ограничение снижения, заданное полем "ДеградированныеresponseTime" на проверке. Применяется только к проверкам API.
За максимальное время отклика	overMaxResponseTime	boolean	Установите значение true, если время отклика превышает ограничение, заданное полем maxResponseTime в проверке. Применяется только к проверкам API.
Расположение запуска	runLocation	string	Из какого расположения центра обработки данных получен результат проверки.
Начало работы	startedAt	date-time	Время начала.
Остановлено	stoppedAt	date-time	Время остановлено.
Создано в	created_at	date-time	При создании.
Время ответа	responseTime	number	Описывает время выполнения соответствующих частей этой проверки. Любое время системы таймера установки, необходимое для запуска этой проверки в серверной части Checkly, не является частью этого.
Проверка API результатов	apiCheckResult	CheckResultAPI	Данные ответа для проверки API.
Результат проверки браузера	browserCheckResult	CheckResultBrowser	Данные ответа для проверки браузера.
Проверка идентификатора запуска	checkRunId	number	Идентификатор конкретного запуска проверки, создавшего этот результат проверки.
Попыток	attempts	number	Как часто эта проверка была извлечена. Это значение будет больше 0, если включена двойная проверка.

CheckResultList

Имя	Путь	Тип	Описание
Товары		CheckResult

CheckStatus

Имя	Путь	Тип	Описание
Имя	name	string	Имя проверки.
Проверка идентификатора	checkId	string	Идентификатор проверки этого состояния принадлежит.
Имеет сбои	hasFailures	boolean	Описывает, завершается ли эта проверка в настоящее время ошибкой. Если одно из утверждений для проверки API завершается ошибкой, это значение имеет значение true. Если проверка браузера завершается ошибкой по какой-либо причине, это верно.
Имеет ошибки	hasErrors	boolean	Описывается, если из-за какой-то ошибки вне обычной операции эта проверка завершается ошибкой. Это должно быть крайне редко и только в том случае, если в серверной части Checkly возникает ошибка.
Деградируется	isDegraded	boolean	Проверка снижается, если она превышает ограничение снижения, заданное полем "ДеградированныеresponseTime" на проверке. Применяется только к проверкам API.
Самый длительный запуск	longestRun	number	Самое длинное время отклика для этой проверки.
Самый короткий запуск	shortestRun	number	Самое короткое время отклика для этой проверки.
Последнее расположение запуска	lastRunLocation	string	В каком расположении эта проверка была выполнена в последний раз.
Идентификатор последнего проверки выполнения	lastCheckRunId	string	Уникальный добавочный идентификатор для каждого запуска проверки.
Оставшиеся дни SSL	sslDaysRemaining	number	Сколько дней остается до истечения срока действия текущего SSL-сертификата.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

CheckStatusList

Имя	Путь	Тип	Описание
Товары		CheckStatus

Проверьте

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя проверки.
Activated	activated	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted	boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck	boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail	boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations	CheckLocationList	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags	CheckTagList	Теги для организации и фильтрации проверок.
Проверка параметров оповещений	alertSettings	CheckAlertSettings	Параметры оповещений.
Использование глобальных параметров оповещений	useGlobalAlertSettings	boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId	number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder	number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId	string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Тип проверки	checkType	string	Тип проверки.
Частота	frequency	integer	Как часто проверка должна выполняться в минутах.
Смещение частоты	frequencyOffset	integer	Смещение частоты.
Проверка запроса	request	CheckRequest	Запрос проверки.
Скрипт	script	string	Скрипт.
Проверка списка переменных среды	environmentVariables	CheckEnvironmentVariableList	Пары "ключ-значение" для задания переменных среды во время проверки. Это относится только к проверкам браузера. По возможности используйте глобальные переменные среды.
Идентификатор фрагмента программы установки	setupSnippetId	number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Идентификатор фрагмента слома	tearDownSnippetId	number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Локальный скрипт установки	localSetupScript	string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript	string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime	number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime	number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
alertChannels	alertChannels	CheckAlertChannels
Частные расположения	privateLocations	privateLocations	Массив одного или нескольких частных расположений, где выполняется проверка.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

CheckList

Имя	Путь	Тип	Описание
Товары		Check

Model14

Имя	Путь	Тип	Описание
Товары		KeyValue

Model15

Имя	Путь	Тип	Описание
Товары		KeyValue

Модель16

Определяет запрос, который будет выполняться проверкой.

Имя	Путь	Тип	Описание
method	method	string
URL	url	string	URL-адрес.
Следуйте перенаправлениям	followRedirects	boolean	Следует ли следовать перенаправлениям.
Пропуск SSL	skipSSL	boolean	Следует ли пропускать SSL.
Тело	body	string	Тело.
Тип телосложения	bodyType	string	Тип тела.
headers	headers	Model14
queryParameters	queryParameters	Model15
Список утверждений	assertions	AssertionList	Ознакомьтесь с основной документацией по проверке утверждений для определенных значений, таких как регулярные выражения и дескрипторы пути JSON, которые можно использовать в поле свойства.
basicAuth	basicAuth	BasicAuth

CheckAPI

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя проверки.
Activated	activated	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted	boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck	boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail	boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations	CheckLocationList	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags	CheckTagList	Теги для организации и фильтрации проверок.
Проверка параметров оповещений	alertSettings	CheckAlertSettings	Параметры оповещений.
Использование глобальных параметров оповещений	useGlobalAlertSettings	boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId	number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder	number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId	string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Проверка запроса	request	Model16	Определяет запрос, который будет выполняться проверкой.
Частота	frequency	integer	Как часто проверка должна выполняться в минутах.
Смещение частоты	frequencyOffset	integer	Используется для установки секунд для проверки частот в течение 1 минут (только для проверок API) и распространения проверок в течение 1 минуты. Это работает следующим образом: проверки с частотой 0 могут иметь частоту 10, 20 или 30 означает, что они будут выполняться каждые 10, 20 или 30 секунд. Проверки с частотой ниже и равным 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.floor(частота * 10), т. е. для проверки, которая выполняется каждые 5 минут, максимальная частотаOffset составляет 50. Проверки с частотой выше 60 могут иметь частотуOffset от 1 до максимальное значение на основе формулы Math.ceil(частота / 60), т. е. для проверки, которая выполняется каждые 720 минут, максимальная частотаOffset составляет 12.
Идентификатор фрагмента слома	tearDownSnippetId	number	Ссылка на идентификатор фрагмента кода, используемого на этапе проверки API.
Идентификатор фрагмента программы установки	setupSnippetId	number	Ссылка на идентификатор фрагмента кода для использования на этапе установки проверки API.
Локальный скрипт установки	localSetupScript	string	Допустимый фрагмент кода Node.js для выполнения на этапе установки.
Локальный скрипт слома	localTearDownScript	string	Допустимый фрагмент кода Node.js, выполняемый на этапе разрыва.
Время отклика с пониженным состоянием	degradedResponseTime	number	Время отклика в миллисекундах, где проверка должна считаться пониженной.
Максимальное время отклика	maxResponseTime	number	Время отклика в миллисекундах, когда проверка должна считаться неудачной.
Частные расположения	privateLocations	privateLocations	Массив одного или нескольких частных расположений, где выполняется проверка.
Тип проверки	checkType	string	Тип проверки.
alertChannels	alertChannels	CheckAlertChannels
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

CheckBrowser

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя проверки.
Activated	activated	boolean	Определяет, выполняется ли проверка.
Приглушенный	muted	boolean	Определяет, будут ли уведомления отправляться при сбое проверки и (или) восстановления.
Двойная проверка	doubleCheck	boolean	Если проверка завершается ошибкой из неудающегося региона, а другой — случайным образом выбран, прежде чем пометить проверку как неудачную.
Ошибка	shouldFail	boolean	Позволяет инвертировать поведение при сбое проверки. Позволяет проверять состояние ошибки, например 404.
Проверка списка расположений	locations	CheckLocationList	Массив одного или нескольких расположений центра обработки данных, где следует выполнить эту проверку.
Проверка списка тегов	tags	CheckTagList	Теги для организации и фильтрации проверок.
Проверка параметров оповещений	alertSettings	CheckAlertSettings	Параметры оповещений.
Использование глобальных параметров оповещений	useGlobalAlertSettings	boolean	Если задано значение true, будет использоваться параметр генерации оповещений уровня учетной записи, а не параметр генерации оповещений, определенный в этой проверке.
Идентификатор группы	groupId	number	Идентификатор группы проверки, в рамках этой проверки.
Порядок групп	groupOrder	number	Позиция этой проверки в группе проверки. Он определяет, в каком порядке выполняются проверки, когда группа активируется из API или из CI/CD.
Идентификатор среды выполнения	runtimeId	string	Версия среды выполнения, т. е. фиксированный набор зависимостей среды выполнения, используемый для выполнения этой проверки.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Тип проверки	checkType	string	Тип проверки.
Частота	frequency	integer	Как часто проверка должна выполняться в минутах.
Скрипт	script	string	Допустимый фрагмент кода javascript Node.js, описывающий взаимодействие браузера с платформами Puppeteer или Playwright.
Частные расположения	privateLocations	privateLocations	Массив одного или нескольких частных расположений, где выполняется проверка.
alertChannels	alertChannels	CheckAlertChannels
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

DashboardTagList

Список одного или нескольких тегов, которые фильтруют, которые проверяют отображение на панели мониторинга.

Имя	Путь	Тип	Описание
Товары		string

Dashboard

Имя	Путь	Тип	Описание
Личный домен	customDomain	string	Личный домен пользователя, например status.example.com. Ознакомьтесь с документацией по обновлению использования DNS и SSL.
Пользовательский URL-адрес	customUrl	string	Имя поддомена в checklyhq.com. Необходимо быть уникальным для всех пользователей.
Logo	logo	string	URL-адрес, указывающий на файл изображения.
Favicon	favicon	string	URL-адрес, указывающий на файл изображения, используемый в качестве панели мониторинга favicon.
Link	link	string	Ссылка URL-адреса для перенаправления при нажатии логотипа панели мониторинга.
Header	header	string	Часть текста, отображаемая в верхней части панели мониторинга.
Description	description	string	Фрагмент текста, отображаемый под заголовком или заголовком панели мониторинга.
Ширина	width	string	Определяет, следует ли использовать весь экран или фокус в центре.
Частота обновления	refreshRate	number	Как часто обновлять панель мониторинга в секундах.
Нумеровать страницы	paginate	boolean	Определяет включение или отключение разбиения на страницы.
Скорость разбиения на страницы	paginationRate	number	Как часто запускать разбиение на страницы в секундах.
Проверка на страницу	checksPerPage	number	Количество проверок, отображаемых на странице.
Использование и оператор	useTagsAndOperator	boolean	Когда следует использовать оператор AND для поиска тегов.
Скрытие тегов	hideTags	boolean	Отображение или скрытие тегов на панели мониторинга.
Список тегов панели мониторинга	tags	DashboardTagList	Список одного или нескольких тегов, которые фильтруют, которые проверяют отображение на панели мониторинга.
Идентификатор панели мониторинга	dashboardId	string	Идентификатор панели мониторинга.

Панель мониторингаList

Имя	Путь	Тип	Описание
Товары		Dashboard

Местоположение

Имя	Путь	Тип	Описание
Регион	region	string	Уникальный идентификатор этого расположения.
Имя	name	string	Понятное имя этого расположения.

LocationList

Имя	Путь	Тип	Описание
Товары		Location

MaintenanceWindowTagList

Имена периода обслуживания проверок и групп должны применяться.

Имя	Путь	Тип	Описание
Товары		string

MaintenanceWindow (Окно обслуживания)

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор периода обслуживания.
Имя	name	string	Имя периода обслуживания.
Список тегов окна обслуживания	tags	MaintenanceWindowTagList	Имена периода обслуживания проверок и групп должны применяться.
Начинается с	startsAt	date	Дата начала периода обслуживания.
Заканчивается в	endsAt	date	Дата окончания периода обслуживания.
Интервал повторения	repeatInterval	number	Интервал повторения периода обслуживания из первого вхождения.
Единица повторения	repeatUnit	string	Стратегия повтора для периода обслуживания.
Повторение заканчивается в	repeatEndsAt	date	Дата окончания периода обслуживания, в которой должно перестать повторяться.
Создано в	created_at	date	Дата создания периода обслуживания.
Обновлено в	updated_at	date	Последняя дата обновления периода обслуживания.

MaintenanceWindowList

Список периодов обслуживания.

Имя	Путь	Тип	Описание
Товары		MaintenanceWindow

CheckAssignment

Имя	Путь	Тип	Описание
Идентификатор	id	guid	Идентификатор.
Проверка идентификатора	checkId	guid	Идентификатор проверки.
Идентификатор частного расположения	privateLocationId	guid	Идентификатор назначенного частного расположения.

checkAssignments

Проверка этого частного расположения назначена.

Имя	Путь	Тип	Описание
Товары		CheckAssignment

GroupAssignment

Имя	Путь	Тип	Описание
Идентификатор	id	guid	Идентификатор.
Идентификатор группы	groupId	number	Идентификатор группы.
Идентификатор частного расположения	privateLocationId	guid	Идентификатор назначенного частного расположения.

groupAssignments

Группа, назначенная этим частным расположением.

Имя	Путь	Тип	Описание
Товары		GroupAssignment

privateLocationKeys

Имя	Путь	Тип	Описание
Идентификатор	id	guid	Идентификатор.
Необработанный ключ	rawKey	string	Необработанный ключ.
Маскированные ключи	maskedKey	string	Значение маскированного ключа.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date	При обновлении по адресу.

ключи

Имя	Путь	Тип	Описание
Товары		privateLocationKeys

privatelocationschema

Имя	Путь	Тип	Описание
Идентификатор	id	guid	Идентификатор.
Имя	name	string	Имя, назначенное частному расположению.
Имя slug	slugName	string	Допустимое имя slug.
Icon	icon	string	Значок частного расположения.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date	При обновлении по адресу.
Проверка назначений	checkAssignments	checkAssignments	Проверка этого частного расположения назначена.
Назначения групп	groupAssignments	groupAssignments	Группа, назначенная этим частным расположением.
ключи	keys	keys
Последнее просмотренное	lastSeen	date	Дата последнего вида.
Число агентов	agentCount	number	Число агентов.

privateLocationsListSchema

Имя	Путь	Тип	Описание
Товары		privatelocationschema

commonPrivateLocationSchemaResponse

Имя	Путь	Тип	Описание
Идентификатор	id	guid	Идентификатор.
Имя	name	string	Имя, назначенное частному расположению.
Имя slug	slugName	string	Допустимое имя slug.
Icon	icon	string	Значок частного расположения.
Создано в	created_at	date	При создании.
Обновлено в	updated_at	date	При обновлении по адресу.
Проверка назначений	checkAssignments	checkAssignments	Проверка этого частного расположения назначена.
Назначения групп	groupAssignments	groupAssignments	Группа, назначенная этим частным расположением.
ключи	keys	keys

Временные метки

Имя	Путь	Тип	Описание
Отметка времени		date-time	Метка времени.

queueSize

Размер очереди.

Имя	Путь	Тип	Описание
Товары		number

oldestScheduledCheckRun

Имя	Путь	Тип	Описание
Товары		number

privateLocationsMetricsHistoryResponseSchema

Имя	Путь	Тип	Описание
Временные метки	timestamps	timestamps
Размер очереди	queueSize	queueSize	Размер очереди.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Проверьте теги.

Имя	Путь	Тип	Описание
Товары		string

ReportingAggregate

Имя	Путь	Тип	Описание
Коэффициент успешности	successRatio	number	Коэффициент успешности проверки выбранного диапазона дат. Процент находится в десятичной форме.
Среднее значение	avg	number	Среднее время отклика выбранного диапазона дат в миллисекундах.
P95	p95	number	Время отклика P95 для выбранного диапазона дат в миллисекундах.
P99	p99	number	Время отклика P99 для выбранного диапазона дат в миллисекундах.

Отчетность

Имя	Путь	Тип	Описание
Имя	name	string	Проверьте имя.
Проверка идентификатора	checkId	string	Проверьте идентификатор.
Тип проверки	checkType	string	Тип проверки.
Деактивировано	deactivated	boolean	Проверьте деактивацию.
Список тегов отчетов	tags	ReportingTagList	Проверьте теги.
aggregate	aggregate	ReportingAggregate

ReportingList

Имя	Путь	Тип	Описание
Товары		Reporting

Режим выполнения

Имя	Путь	Тип	Описание
Имя	name	string	Уникальное имя этой среды выполнения.
Этап	stage	string	Текущий этап жизни среды выполнения.
Окончание срока выполнения	runtimeEndOfLife	string	Дата удаления среды выполнения с нашей платформы.
По умолчанию	default	boolean	Указывает, является ли это текущей средой выполнения по умолчанию, предоставляемой Checkly.
Description	description	string	Краткое описание основных обновлений в этой среде выполнения.
String	dependencies.string	string	Строка.

RuntimeList

Имя	Путь	Тип	Описание
Товары		Runtime

Обрезок

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Имя	name	string	Имя фрагмента кода.
Скрипт	script	string	Код Node.js, взаимодействующий со жизненным циклом проверки API, или функции в качестве частичного для проверок браузера.
Создано в	created_at	date-time	При создании.
Обновлено в	updated_at	date-time	При обновлении по адресу.

Фрагмент списка

Имя	Путь	Тип	Описание
Товары		Snippet

CheckGroupTrigger

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Токен	token	string	Маркер.
Создано в	created_at	date	При создании.
Вызывается в	called_at	date	При вызове.
Обновлено в	updated_at	date	При обновлении по адресу.
Идентификатор группы	groupId	number	Идентификатор группы.

CheckTrigger

Имя	Путь	Тип	Описание
Идентификатор	id	number	Идентификатор.
Токен	token	string	Маркер.
Создано в	created_at	date	При создании.
Вызывается в	called_at	date	При вызове.
Обновлено в	updated_at	date	При обновлении по адресу.
Проверка идентификатора	checkId	string	Идентификатор проверки.

объект

Это тип object.

струна

Это базовый тип данных string.