Checkly (Independent Publisher) (Versão prévia)

Checkly é a plataforma de monitoramento para a pilha moderna: JavaScript programável, flexível e amoroso. Monitore e valide suas transações de site cruciais. Colete automaticamente rastreamentos de erros, capturas de tela e métricas de desempenho a cada verificação executada.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Publicador	Troy Taylor
Site	https://www.checklyhq.com/
Política de privacidade	https://www.checklyhq.com/privacy
Categorias	Operações de TI

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
AccountID	secureString	A ID da conta dessa API.	Verdade
Chave de API (no formato 'Bearer apiKey')	secureString	A chave de API (no formato 'Bearer apiKey') para esta api	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar as assinaturas de um canal de alerta	Atualize as assinaturas de um canal de alerta. Use isso para adicionar uma verificação a um canal de alerta para que os alertas de falha e recuperação sejam enviados para essa verificação. Observação: ao passar o objeto de assinatura, você só pode especificar um checkId ou um groupId, não ambos.
Atualizar um canal de alerta	Atualize um canal de alerta.
Atualizar um grupo de verificação	Atualiza um grupo de verificação.
Atualizar um local privado	Atualiza um local privado.
Atualizar um painel	Atualiza um painel. Retornará um 409 ao tentar criar um dashboard com uma URL personalizada ou um domínio personalizado que já foi feito.
Atualizar um snippet	Atualiza um snippet de código.
Atualizar uma janela de manutenção	Atualiza uma janela de manutenção.
Atualizar uma variável de ambiente	Atualiza uma variável de ambiente. Usa o campo de chave como o identificador para atualização. Atualiza apenas o valor e a propriedade bloqueada.
Atualizar uma verificação [PRETERIDA]	[PRETERIDO] Esse ponto de extremidade será removido na segunda-feira, 4 de julho de 2022. Em vez disso, use `PUT /checks/api/{id}` ou `PUT /checks/browser/{id}`. Atualiza uma nova verificação de API ou navegador.
Atualizar uma verificação de API	Atualiza uma verificação de API.
Atualizar uma verificação do navegador	Atualiza uma verificação do navegador.
Criar o gatilho de verificação	Cria o gatilho de verificação.
Criar o gatilho do grupo de verificação	Cria o gatilho do grupo de verificação.
Criar um canal de alerta	Cria um novo canal de alerta.
Criar um grupo de verificação	Cria um novo grupo de verificação. Você pode adicionar verificações ao grupo definindo a propriedade groupId de verificações individuais.
Criar um local privado	Cria um novo local privado.
Criar um painel de controle	Cria um novo painel. Retornará um 409 ao tentar criar um dashboard com uma URL personalizada ou um domínio personalizado que já foi feito.
Criar um snippet	Cria um novo snippet de código.
Criar uma janela de manutenção	Cria uma nova janela de manutenção.
Criar uma variável de ambiente	Cria uma nova variável de ambiente.
Criar uma verificação [PRETERIDA]	[PRETERIDO] Esse ponto de extremidade será removido na segunda-feira, 4 de julho de 2022. Em vez disso, use `POST /checks/api` ou `POST /checks/browser`. Cria uma nova verificação de API ou navegador. Retornará um `402` quando você estiver acima do limite do seu plano. Ao usar o `globalAlertSettings`, o `alertSettings` pode ser `null`
Criar uma verificação de API	Cria uma nova verificação de API. Retornará um `402` quando você estiver acima do limite do seu plano. Ao usar o `globalAlertSetting`, o `alertSetting` pode ser `null`
Criar uma verificação do navegador	Cria uma nova verificação do navegador. Retornará um `402` quando você estiver acima do limite do seu plano. Ao usar o `globalAlertSetting`, o `alertSetting` pode ser `null`
Excluir o gatilho de verificação	Exclui o gatilho de verificação.
Excluir o gatilho do grupo de verificação	Exclui o gatilho de grupos de verificação.
Excluir um canal de alerta	Remove permanentemente um canal de alerta.
Excluir um dashboard	Remove permanentemente um painel.
Excluir um grupo de verificação	Remove permanentemente um grupo de verificação. Você não poderá excluir um grupo de verificação se ele ainda contiver verificações.
Excluir um snippet	Remove permanentemente um snippet.
Excluir uma janela de manutenção	Remove permanentemente uma janela de manutenção.
Excluir uma variável de ambiente	Remove permanentemente uma variável de ambiente. Usa o campo de chave como o identificador para exclusão.
Excluir uma verificação	Remove permanentemente uma verificação de API ou navegador e todos os seus dados de status e resultados relacionados.
Gera um relatório com estatísticas de agregação para verificações e grupos de verificação	Gera um relatório com estatísticas agregadas para todas as verificações ou um conjunto filtrado de verificações em uma janela de tempo especificada.
Gera um relatório personalizável para todas as métricas de Verificação do Navegador	Gera um relatório com estatísticas agregadas ou não agregadas para uma verificação de navegador específica em uma janela de tempo especificada.
Gerar uma nova chave de API para um local privado	Cria uma chave de api no local privado.
Lista todos os locais com suporte	Lista todos os locais com suporte.
Lista todos os resultados de verificação	Lista os resultados completos de verificação bruta para uma verificação específica. Mantemos resultados brutos por 30 dias. Depois de 30 dias, eles são apagados. No entanto, mantemos os resultados acumulados por um período indefinido. Você pode filtrar por tipo de verificação e tipo de resultado para restringir a lista. Use os `to` parâmetros e `from` para especificar um intervalo de datas (carimbo de data/hora UNIX em segundos). Dependendo do tipo de verificação, alguns campos podem ser nulos. Esse ponto de extremidade retornará dados dentro de um período de seis horas. Se de e params estão definidos, eles devem ter no máximo seis horas de diferença. Se nenhum estiver definido, consideraremos o parâmetro para ser agora e do param para ser seis horas antes. Se apenas o parâmetro for definido, definiremos de seis horas antes. Pelo contrário, se apenas o parâmetro do parâmetro estiver definido, consideraremos o parâmetro para ser seis horas depois. A limitação de taxa é aplicada a esse ponto de extremidade, você pode enviar no máximo 5 solicitações/10 segundos.
Lista todos os runtimes com suporte	Lista todos os runtimes com suporte e os pacotes NPM incluídos para verificações de navegador e configuração e scripts de teardown para verificações de API.
Listar alertas para uma verificação específica	Lista todos os alertas para uma verificação específica.
Listar todas as janelas de manutenção	Lista todas as janelas de manutenção em sua conta.
Listar todas as variáveis de ambiente	Lista todas as variáveis de ambiente atuais em sua conta.
Listar todas as verificações	Lista todas as verificações atuais em sua conta.
Listar todos os alertas para sua conta	Lista todos os alertas para sua conta.
Listar todos os canais de alerta	Lista todos os canais de alerta configurados e suas verificações assinadas.
Listar todos os grupos de verificação	Lista todos os grupos de verificação atuais em sua conta. A propriedade checks é uma matriz de verificação de UUID's para referência conveniente. Ele é somente leitura e você não pode usá-lo para adicionar verificações a um grupo.
Listar todos os locais privados	Lista todos os locais privados em sua conta.
Listar todos os painéis	Lista todos os painéis atuais em sua conta.
Listar todos os snippets	Lista todos os snippets atuais em sua conta.
Listar todos os status de verificação	Mostra as informações de status atuais de todas as verificações em sua conta. Os registros de status de verificação são atualizados continuamente à medida que novos resultados de verificação chegam.
Mostra detalhes de um runtime específico	Mostra os detalhes de todos os pacotes NPM incluídos e sua versão para um runtime específico.
Obter métricas de integridade de local privado de uma janela de tempo	Obtenha métricas de integridade de local privado de uma janela de tempo.
Obter o gatilho de verificação	Localiza o gatilho de verificação.
Obter o gatilho do grupo de verificação	Localiza o gatilho do grupo de verificação.
Obter o selo de status do grupo	Obtenha o selo de status do grupo.
Obter selo de status de verificação	Obtenha o selo de status de verificação.
Recuperar detalhes de status de verificação	Mostrar as informações de status atuais para uma verificação específica.
Recuperar todas as verificações em um grupo específico com as configurações de grupo aplicadas	Lista todas as verificações em um grupo de verificação específico com as configurações de grupo aplicadas.
Recuperar um canal de alerta	Mostrar detalhes de um canal de alerta específico.
Recuperar um grupo de verificação	Mostrar detalhes de um grupo de verificação específico.
Recuperar um local privado	Mostrar detalhes de um local privado específico.
Recuperar um resultado de verificação	Mostrar detalhes de um resultado de verificação específico.
Recuperar um snippet	Mostrar detalhes de um snippet específico.
Recuperar uma janela de manutenção	Mostrar detalhes de uma janela de manutenção específica.
Recuperar uma variável de ambiente	Mostrar detalhes de uma variável de ambiente específica. Usa o campo de chave para seleção.
Recuperar uma verificação	Mostrar detalhes de uma API específica ou verificação de navegador.
Recuperar uma verificação em um grupo específico com as configurações de grupo aplicadas	Mostrar detalhes de uma verificação em um grupo de verificação específico com as configurações de grupo aplicadas.
Remover um local privado	Remove permanentemente um local privado.
Remover uma chave de API existente para um local privado	Remove permanentemente uma chave de api de um local privado.

Atualizar as assinaturas de um canal de alerta

ID da operação:: PutV1AlertchannelsIdSubscriptions

Atualize as assinaturas de um canal de alerta. Use isso para adicionar uma verificação a um canal de alerta para que os alertas de falha e recuperação sejam enviados para essa verificação. Observação: ao passar o objeto de assinatura, você só pode especificar um checkId ou um groupId, não ambos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
Verificar ID	checkId		guid	Você pode passar uma checkId ou uma groupId, mas não ambas.
ID do grupo	groupId		number	Você pode passar uma checkId ou uma groupId, mas não ambas.
Activated	activated	True	boolean	Se ativado.

Retornos

Corpo: AlertChanelSubscription

Atualizar um canal de alerta

ID da operação:: PutV1AlertchannelsId

Atualize um canal de alerta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
ID	id		number	O identificador.
Verificar ID	checkId		guid	O identificador de verificação.
ID do grupo	groupId		number	O identificador do grupo.
Activated	activated	True	boolean	Se ativado.
Tipo	type	True	string	O tipo.
Configuração criar canal de alerta	config	True	object	A configuração de criação do canal de alerta.
Enviar Recuperação	sendRecovery		boolean	Se enviar recuperação.
Falha de envio	sendFailure		boolean	Se a falha de envio.
Enviar degradado	sendDegraded		boolean	Se o envio foi degradado.
Expiração do SSL	sslExpiry		boolean	Determina se um alerta deve ser enviado para certificados SSL expirando.
Limite de expiração do SSL	sslExpiryThreshold		integer	Em que momento começar a alertar sobre certificados SSL.

Retornos

Corpo: AlertChannel

Atualizar um grupo de verificação

ID da operação:: PutV1CheckgroupsId

Atualiza um grupo de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name		string	O nome do grupo de verificação.
Activated	activated		boolean	Determina se as verificações no grupo estão em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando um check-in desse grupo falhar e/ou se recuperar.
Verificar lista de marcas de grupo	tags		array of string	Marcas para organizar e filtrar verificações.
Verificar a lista de localização do grupo	locations		array of string	Uma matriz de um ou mais locais de data center onde executar as verificações.
Concurrency	concurrency		number	Determina quantas verificações são invocadas simultaneamente ao disparar um grupo de verificação de CI/CD ou por meio da API.
URL	url		string	A URL base desse grupo que você pode referenciar com a variável {{GROUP_BASE_URL}} em todas as verificações de grupo.
Key	key	True	string	A chave.
Value	value	True	string	O valor.
Bloqueado	locked		boolean	Se está bloqueado.
Source	source		string	A origem.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Meta	target		string	O destino.
Nome de usuário	username	True	string	O nome de usuário.
Senha	password	True	string	A senha.
Verificar padrões de verificação de criação de navegador do grupo	browserCheckDefaults		object	O grupo de verificação cria padrões de verificação do navegador.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, conjunto fixo de dependências de runtime, usado para executar verificações nesse grupo.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida neste grupo de verificação.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API nesse grupo.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API nesse grupo.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação de uma verificação de API neste grupo.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown de uma verificação de API neste grupo.
Verificar locais privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar as verificações.

Retornos

Corpo: CheckGroup

Atualizar um local privado

ID da operação:: PutV1PrivatelocationsId

Atualiza um local privado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
Nome	name	True	string	O nome atribuído ao local privado.
Ícone	icon		string	O ícone.

Retornos

Corpo: commonPrivateLocationSchemaResponse

Atualizar um painel

ID da operação:: PutV1DashboardsDashboardid

Atualiza um painel. Retornará um 409 ao tentar criar um dashboard com uma URL personalizada ou um domínio personalizado que já foi feito.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	dashboardId	True	string	O identificador do painel.
URL personalizada	customUrl		string	Um nome de subdomínio em checklyhq.com. Precisa ser exclusivo em todos os usuários.
Custom Domain	customDomain		string	Um domínio de usuário personalizado, por exemplo, status.example.com. Consulte os documentos sobre como atualizar o uso de DNS e SSL.
Logotipo	logo		string	Uma URL apontando para um arquivo de imagem.
Favicon	favicon		string	Uma URL que aponta para um arquivo de imagem usado como favicon do painel.
Link	link		string	Um link de URL para redirecionar quando o logotipo do painel é clicado.
Header	header		string	Um pedaço de texto exibido na parte superior do painel.
Description	description		string	Um trecho de texto exibido abaixo do cabeçalho ou título do painel.
Largura	width		string	Determina se a tela inteira ou o foco deve ser usado no centro.
Taxa de Atualização	refreshRate		number	Com que frequência atualizar o painel em segundos.
Paginar	paginate		boolean	Determina se a paginação está ativada ou desativada.
Taxa de Paginação	paginationRate		number	Com que frequência disparar a paginação em segundos.
Verificações por página	checksPerPage		number	Número de verificações exibidas por página.
Usar e operador	useTagsAndOperator		boolean	Quando usar o operador AND para pesquisa de marcas.
Ocultar marcas	hideTags		boolean	Mostrar ou ocultar as marcas no painel.
Lista de marcas do painel	tags		array of string	Uma lista de uma ou mais marcas que filtram as verificações a serem exibidas no painel.

Retornos

Corpo: Dashboard

Atualizar um snippet

ID da operação:: PutV1SnippetsId

Atualiza um snippet de código.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
Nome	name	True	string	O nome do snippet.
Script	script	True	string	Seu Node.js código que interage com o ciclo de vida de verificação de API ou funciona como parcial para verificações do navegador.

Retornos

Corpo: Snippet

Atualizar uma janela de manutenção

ID da operação:: PutV1MaintenancewindowsId

Atualiza uma janela de manutenção.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
Nome	name	True	string	O nome da janela de manutenção.
Lista de marcas da janela de manutenção	tags		array of string	Os nomes da janela de manutenção de verificações e grupos devem ser aplicados.
Inicia em	startsAt	True	date	A data de início da janela de manutenção.
Termina em	endsAt	True	date	A data de término da janela de manutenção.
Repetir intervalo	repeatInterval		number	O intervalo de repetição da janela de manutenção da primeira ocorrência.
Repetir Unidade	repeatUnit	True	string	A estratégia de repetição da janela de manutenção.
Repetir termina em	repeatEndsAt		date	A data de término em que a janela de manutenção deve parar de repetir.

Retornos

Corpo: MaintenanceWindow

Atualizar uma variável de ambiente

ID da operação:: PutV1VariablesKey

Atualiza uma variável de ambiente. Usa o campo de chave como o identificador para atualização. Atualiza apenas o valor e a propriedade bloqueada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Key	key	True	string	A chave.
Key	key		string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.

Retornos

Corpo: EnvironmentVariable

Atualizar uma verificação [PRETERIDA]

ID da operação:: PutV1ChecksId

[PRETERIDO] Esse ponto de extremidade será removido na segunda-feira, 4 de julho de 2022. Em vez disso, use PUT /checks/api/{id} ou PUT /checks/browser/{id}. Atualiza uma nova verificação de API ou navegador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name		string	O nome da verificação.
Activated	activated		boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Tipo de verificação	checkType		string	O tipo da verificação.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para verificar frequências em menos de 1 minuto (apenas para verificações de API) e propagar verificações em um intervalo de tempo para frequências ao longo de 1 minuto. Isso funciona da seguinte maneira: verificações com uma frequência de 0 podem ter um frequencyOffset de 10, 20 ou 30, o que significa que eles serão executados a cada 10, 20 ou 30 segundos. Verificações com uma frequência inferior e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequency * 10), ou seja, para uma verificação que é executada a cada 5 minutos, a frequência máximaOffset é 50. Verificações com uma frequência maior que 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.ceil(frequency/60), ou seja, para uma verificação que é executada a cada 720 minutos, a frequência máximaOffset é 12.
Verificar Solicitação	request	True	object	A solicitação de verificação.
Script	script	True	string	O script.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: Check

Atualizar uma verificação de API

ID da operação:: PutV1ChecksApiId

Atualiza uma verificação de API.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name		string	O nome da verificação.
Activated	activated		boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
método	method	True	string
URL	url	True	string	O endereço da URL.
Seguir redirecionamentos	followRedirects		boolean	Se deseja seguir redirecionamentos.
Ignorar SSL	skipSSL		boolean	Se deseja ignorar o SSL.
Corpo	body		string	O corpo.
Tipo de corpo	bodyType		string	O tipo de corpo.
Key	key	True	string	A chave.
Value	value	True	string	O valor.
Bloqueado	locked		boolean	Se está bloqueado.
Source	source		string	A origem.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Meta	target		string	O destino.
Nome de usuário	username	True	string	O nome de usuário.
Senha	password	True	string	A senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para verificar as frequências em menos de 1 minutos e a distribuição de verificações em um intervalo de tempo para frequências acima de 1 minuto. Isso funciona da seguinte maneira: verificações com uma frequência de 0 podem ter um frequencyOffset de 10, 20 ou 30, o que significa que eles serão executados a cada 10, 20 ou 30 segundos. Verificações com uma frequência inferior e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequency * 10), ou seja, para uma verificação que é executada a cada 5 minutos, a frequência máximaOffset é 50. Verificações com uma frequência maior que 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.ceil(frequency/60), ou seja, para uma verificação que é executada a cada 720 minutos, a frequência máximaOffset é 12.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: CheckAPI

Atualizar uma verificação do navegador

ID da operação:: PutV1ChecksBrowserId

Atualiza uma verificação do navegador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name		string	O nome da verificação.
Activated	activated		boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
Script	script		string	Uma parte válida de Node.js código javascript que descreve uma interação do navegador com as estruturas puppeteer ou playwright.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: CheckBrowser

Criar o gatilho de verificação

ID da operação:: PostV1TriggersChecksCheckid

Cria o gatilho de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Retornos

Corpo: CheckTrigger

Criar o gatilho do grupo de verificação

ID da operação:: PostV1TriggersCheckgroupsGroupid

Cria o gatilho do grupo de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	groupId	True	integer	O identificador do grupo.

Retornos

Corpo: CheckGroupTrigger

Criar um canal de alerta

ID da operação:: PostV1Alertchannels

Cria um novo canal de alerta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id		number	O identificador.
Verificar ID	checkId		guid	O identificador de verificação.
ID do grupo	groupId		number	O identificador do grupo.
Activated	activated	True	boolean	Se ativado.
Tipo	type	True	string	O tipo.
Configuração criar canal de alerta	config	True	object	A configuração de criação do canal de alerta.
Enviar Recuperação	sendRecovery		boolean	Se enviar recuperação.
Falha de envio	sendFailure		boolean	Se a falha de envio.
Enviar degradado	sendDegraded		boolean	Se o envio foi degradado.
Expiração do SSL	sslExpiry		boolean	Determina se um alerta deve ser enviado para certificados SSL expirando.
Limite de expiração do SSL	sslExpiryThreshold		integer	Em que momento começar a alertar sobre certificados SSL.

Retornos

Corpo: AlertChannel

Criar um grupo de verificação

ID da operação:: PostV1Checkgroups

Cria um novo grupo de verificação. Você pode adicionar verificações ao grupo definindo a propriedade groupId de verificações individuais.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name	True	string	O nome do grupo de verificação.
Activated	activated		boolean	Determina se as verificações no grupo estão em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando um check-in desse grupo falhar e/ou se recuperar.
Verificar lista de marcas de grupo	tags		array of string	Marcas para organizar e filtrar verificações.
Verificar a lista de localização do grupo	locations		array of string	Uma matriz de um ou mais locais de data center onde executar as verificações.
Concurrency	concurrency		number	Determina quantas verificações são invocadas simultaneamente ao disparar um grupo de verificação de CI/CD ou por meio da API.
URL	url		string	A URL base desse grupo que você pode referenciar com a variável {{GROUP_BASE_URL}} em todas as verificações de grupo.
Key	key	True	string	A chave.
Value	value	True	string	O valor.
Bloqueado	locked		boolean	Se está bloqueado.
Source	source		string	A origem.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Meta	target		string	O destino.
Nome de usuário	username	True	string	O nome de usuário.
Senha	password	True	string	A senha.
Verificar padrões de verificação de criação de navegador do grupo	browserCheckDefaults		object	O grupo de verificação cria padrões de verificação do navegador.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, conjunto fixo de dependências de runtime, usado para executar verificações nesse grupo.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida neste grupo de verificação.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API nesse grupo.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API nesse grupo.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação de uma verificação de API neste grupo.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown de uma verificação de API neste grupo.
Verificar locais privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar as verificações.

Retornos

Corpo: CheckGroup

Criar um local privado

ID da operação:: PostV1Privatelocations

Cria um novo local privado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome atribuído ao local privado.
Nome da lesma	slugName	True	string	Nome de lesma válido.
Ícone	icon		string	O ícone.

Retornos

Corpo: commonPrivateLocationSchemaResponse

Criar um painel de controle

ID da operação:: PostV1Dashboards

Cria um novo painel. Retornará um 409 ao tentar criar um dashboard com uma URL personalizada ou um domínio personalizado que já foi feito.

Parâmetros

Nome	Chave	Tipo	Description
URL personalizada	customUrl	string	Um nome de subdomínio em checklyhq.com. Precisa ser exclusivo em todos os usuários.
Custom Domain	customDomain	string	Um domínio de usuário personalizado, por exemplo, status.example.com. Consulte os documentos sobre como atualizar o uso de DNS e SSL.
Logotipo	logo	string	Uma URL apontando para um arquivo de imagem.
Favicon	favicon	string	Uma URL que aponta para um arquivo de imagem usado como favicon do painel.
Link	link	string	Um link de URL para redirecionar quando o logotipo do painel é clicado.
Header	header	string	Um pedaço de texto exibido na parte superior do painel.
Description	description	string	Um trecho de texto exibido abaixo do cabeçalho ou título do painel.
Largura	width	string	Determina se a tela inteira ou o foco deve ser usado no centro.
Taxa de Atualização	refreshRate	number	Com que frequência atualizar o painel em segundos.
Paginar	paginate	boolean	Determina se a paginação está ativada ou desativada.
Taxa de Paginação	paginationRate	number	Com que frequência disparar a paginação em segundos.
Verificações por página	checksPerPage	number	Número de verificações exibidas por página.
Usar e operador	useTagsAndOperator	boolean	Quando usar o operador AND para pesquisa de marcas.
Ocultar marcas	hideTags	boolean	Mostrar ou ocultar as marcas no painel.
Lista de marcas do painel	tags	array of string	Uma lista de uma ou mais marcas que filtram as verificações a serem exibidas no painel.

Retornos

Corpo: Dashboard

Criar um snippet

ID da operação:: PostV1Snippets

Cria um novo snippet de código.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome do snippet.
Script	script	True	string	Seu Node.js código que interage com o ciclo de vida de verificação de API ou funciona como parcial para verificações do navegador.

Retornos

Corpo: Snippet

Criar uma janela de manutenção

ID da operação:: PostV1Maintenancewindows

Cria uma nova janela de manutenção.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome da janela de manutenção.
Lista de marcas da janela de manutenção	tags		array of string	Os nomes da janela de manutenção de verificações e grupos devem ser aplicados.
Inicia em	startsAt	True	date	A data de início da janela de manutenção.
Termina em	endsAt	True	date	A data de término da janela de manutenção.
Repetir intervalo	repeatInterval		number	O intervalo de repetição da janela de manutenção da primeira ocorrência.
Repetir Unidade	repeatUnit	True	string	A estratégia de repetição da janela de manutenção.
Repetir termina em	repeatEndsAt		date	A data de término em que a janela de manutenção deve parar de repetir.

Retornos

Corpo: MaintenanceWindow

Criar uma variável de ambiente

ID da operação:: PostV1Variables

Cria uma nova variável de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.

Retornos

Corpo: EnvironmentVariable

Criar uma verificação [PRETERIDA]

ID da operação:: PostV1Checks

[PRETERIDO] Esse ponto de extremidade será removido na segunda-feira, 4 de julho de 2022. Em vez disso, use POST /checks/api ou POST /checks/browser. Cria uma nova verificação de API ou navegador. Retornará um 402 quando você estiver acima do limite do seu plano. Ao usar o globalAlertSettings, o alertSettings pode ser null

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name	True	string	O nome da verificação.
Activated	activated	True	boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Tipo de verificação	checkType	True	string	O tipo da verificação.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para verificar frequências em menos de 1 minuto (apenas para verificações de API) e propagar verificações em um intervalo de tempo para frequências ao longo de 1 minuto. Isso funciona da seguinte maneira: verificações com uma frequência de 0 podem ter um frequencyOffset de 10, 20 ou 30, o que significa que eles serão executados a cada 10, 20 ou 30 segundos. Verificações com uma frequência inferior e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequency * 10), ou seja, para uma verificação que é executada a cada 5 minutos, a frequência máximaOffset é 50. Verificações com uma frequência maior que 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.ceil(frequency/60), ou seja, para uma verificação que é executada a cada 720 minutos, a frequência máximaOffset é 12.
Verificar Solicitação	request		object	A solicitação de verificação.
Script	script	True	string	O script.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: Check

Criar uma verificação de API

ID da operação:: PostV1ChecksApi

Cria uma nova verificação de API. Retornará um 402 quando você estiver acima do limite do seu plano. Ao usar o globalAlertSetting, o alertSetting pode ser null

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name	True	string	O nome da verificação.
Activated	activated	True	boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
método	method	True	string
URL	url	True	string	O endereço da URL.
Seguir redirecionamentos	followRedirects		boolean	Se segue redirecionamentos.
Ignorar SSL	skipSSL		boolean	Se deseja ignorar o SSL.
Corpo	body		string	O corpo.
bodyType	bodyType		string
Key	key	True	string	A chave.
Value	value	True	string	O valor.
Bloqueado	locked		boolean	Se está bloqueado.
Source	source		string	A origem.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Meta	target		string	O destino.
Nome de usuário	username	True	string	O nome de usuário.
Senha	password	True	string	A senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
ID do snippet de demolição	tearDownSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Configurar a ID do snippet	setupSnippetId		number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para verificar as frequências em menos de 1 minutos e a distribuição de verificações em um intervalo de tempo para frequências acima de 1 minuto. Isso funciona da seguinte maneira: verificações com uma frequência de 0 podem ter um frequencyOffset de 10, 20 ou 30, o que significa que eles serão executados a cada 10, 20 ou 30 segundos. Verificações com uma frequência inferior e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequency * 10), ou seja, para uma verificação que é executada a cada 5 minutos, a frequência máximaOffset é 50. Verificações com uma frequência maior que 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.ceil(frequency/60), ou seja, para uma verificação que é executada a cada 720 minutos, a frequência máximaOffset é 12.
Script de instalação local	localSetupScript		string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript		string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime		number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: CheckAPI

Criar uma verificação do navegador

ID da operação:: PostV1ChecksBrowser

Cria uma nova verificação do navegador. Retornará um 402 quando você estiver acima do limite do seu plano. Ao usar o globalAlertSetting, o alertSetting pode ser null

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Atribuir alertas automaticamente	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando ela for criada.
Nome	name	True	string	O nome da verificação.
Activated	activated	True	boolean	Determina se a verificação está em execução ou não.
Abafado	muted		boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck		boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations		array of string	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags		array of string	Marcas para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina que tipo de escalonamento usar.
Limite de execução com falha	failedRunThreshold		number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.
Limite de falha de minutos	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Quantidade	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Enabled	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold		integer	Em que momento começar a alertar sobre certificados SSL.
Usar configurações de alerta global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId		number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId		string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
ID do Canal de Alerta	alertChannelId	True	number	O identificador do canal de alerta.
Activated	activated	True	boolean	Se ativado.
Key	key	True	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	True	string	O valor da variável de ambiente.
Bloqueado	locked		boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
Script	script	True	string	Uma parte válida de Node.js código javascript que descreve uma interação do navegador com as estruturas puppeteer ou playwright.
Locais Privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Retornos

Corpo: CheckBrowser

Excluir o gatilho de verificação

ID da operação:: DeleteV1TriggersChecksCheckid

Exclui o gatilho de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Excluir o gatilho do grupo de verificação

ID da operação:: DeleteV1TriggersCheckgroupsGroupid

Exclui o gatilho de grupos de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	groupId	True	integer	O identificador do grupo.

Excluir um canal de alerta

ID da operação:: DeleteV1AlertchannelsId

Remove permanentemente um canal de alerta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Excluir um dashboard

ID da operação:: DeleteV1DashboardsDashboardid

Remove permanentemente um painel.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	dashboardId	True	string	O identificador do painel.

Excluir um grupo de verificação

ID da operação:: DeleteV1CheckgroupsId

Remove permanentemente um grupo de verificação. Você não poderá excluir um grupo de verificação se ele ainda contiver verificações.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Excluir um snippet

ID da operação:: DeleteV1SnippetsId

Remove permanentemente um snippet.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Excluir uma janela de manutenção

ID da operação:: DeleteV1MaintenancewindowsId

Remove permanentemente uma janela de manutenção.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Excluir uma variável de ambiente

ID da operação:: DeleteV1VariablesKey

Remove permanentemente uma variável de ambiente. Usa o campo de chave como o identificador para exclusão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Key	key	True	string	A chave.

Excluir uma verificação

ID da operação:: DeleteV1ChecksId

Remove permanentemente uma verificação de API ou navegador e todos os seus dados de status e resultados relacionados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Gera um relatório com estatísticas de agregação para verificações e grupos de verificação

ID da operação:: GetV1Reporting

Gera um relatório com estatísticas agregadas para todas as verificações ou um conjunto filtrado de verificações em uma janela de tempo especificada.

Parâmetros

Nome	Chave	Tipo	Description
De	from	date	Hora de início personalizada da janela de relatório no formato de carimbo de data/hora unix. Definir um personalizado do carimbo de data/hora substitui o uso de qualquer presetWindow.
Para	to	date	Hora de término personalizada da janela de relatório no formato de carimbo de data/hora unix. Definir um personalizado para o carimbo de data/hora substitui o uso de qualquer presetWindow.
Janela predefinida	presetWindow	string	Janelas de relatórios predefinida são usadas para gerar relatórios rapidamente em janelas comumente usadas. Pode ser substituído usando um carimbo de data/hora personalizado.
Filtrar por marcas	filterByTags	array	Use marcas para filtrar as verificações que você deseja ver em seu relatório.
Desativado	deactivated	boolean	Filtrar verificações por status ativado.

Retornos

Itens: ReportingList

Gera um relatório personalizável para todas as métricas de Verificação do Navegador

ID da operação:: GetV2ReportingBrowserchecksId

Gera um relatório com estatísticas agregadas ou não agregadas para uma verificação de navegador específica em uma janela de tempo especificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
De	from		date	Hora de início personalizada da janela de relatório no formato de carimbo de data/hora unix. Definir um personalizado do carimbo de data/hora substitui o uso de qualquer presetWindow.
Para	to		date	Hora de término personalizada da janela de relatório no formato de carimbo de data/hora unix. Definir um personalizado para o carimbo de data/hora substitui o uso de qualquer presetWindow.
Janela predefinida	presetWindow		string	Janelas de relatórios predefinida são usadas para gerar relatórios rapidamente em janelas comumente usadas. Pode ser substituído usando um carimbo de data/hora personalizado.
Intervalo de agregação	aggregationInterval		number	O intervalo de tempo a ser usado para agregar métricas em minutos. Por exemplo, cinco minutos são 300, 24 horas é 1440.
Agrupar por	groupBy		string	Determina como os dados da série são agrupados.
Filtrar por status	filterByStatus		array	Use o status para filtrar a verificação de dados de resultados com falha ou de verificação bem-sucedida.
Métricas	metrics		array	opções de métricas para verificações de navegador.

Retornos

Os atributos.

Attributes: object

Gerar uma nova chave de API para um local privado

ID da operação:: PostV1PrivatelocationsIdKeys

Cria uma chave de api no local privado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Corpo: privateLocationKeys

Lista todos os locais com suporte

ID da operação:: GetV1Locations

Lista todos os locais com suporte.

Retornos

Itens: LocationList

Lista todos os resultados de verificação

ID da operação:: GetV1CheckresultsCheckid

Lista os resultados completos de verificação bruta para uma verificação específica. Mantemos resultados brutos por 30 dias. Depois de 30 dias, eles são apagados. No entanto, mantemos os resultados acumulados por um período indefinido. Você pode filtrar por tipo de verificação e tipo de resultado para restringir a lista. Use os to parâmetros e from para especificar um intervalo de datas (carimbo de data/hora UNIX em segundos). Dependendo do tipo de verificação, alguns campos podem ser nulos. Esse ponto de extremidade retornará dados dentro de um período de seis horas. Se de e params estão definidos, eles devem ter no máximo seis horas de diferença. Se nenhum estiver definido, consideraremos o parâmetro para ser agora e do param para ser seis horas antes. Se apenas o parâmetro for definido, definiremos de seis horas antes. Pelo contrário, se apenas o parâmetro do parâmetro estiver definido, consideraremos o parâmetro para ser seis horas depois. A limitação de taxa é aplicada a esse ponto de extremidade, você pode enviar no máximo 5 solicitações/10 segundos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.
De	from		date	Selecione documentos acima deste carimbo de data/hora UNIX (>= data). O padrão é agora - 6 horas.
Para	to		date	Selecione alertas até este carimbo de data/hora UNIX (< data). O padrão é de 6 horas depois.
Localização	location		string	Forneça um local de data center, por exemplo, eu-oeste-1 para filtrar por local
Tipo de verificação	checkType		string	O tipo da verificação.
Tem falhas	hasFailures		boolean	O resultado da verificação tem uma ou mais falhas.

Retornos

Itens: CheckResultList

Lista todos os runtimes com suporte

ID da operação:: GetV1Runtimes

Lista todos os runtimes com suporte e os pacotes NPM incluídos para verificações de navegador e configuração e scripts de teardown para verificações de API.

Retornos

Itens: RuntimeList

Listar alertas para uma verificação específica

ID da operação:: GetV1CheckalertsCheckid

Lista todos os alertas para uma verificação específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.
De	from		date	Selecione documentos acima deste carimbo de data/hora UNIX (>= data). O padrão é agora - 6 horas.
Para	to		date	Selecione alertas até este carimbo de data/hora UNIX (< data). O padrão é de 6 horas depois.

Retornos

Itens: CheckAlertList

Listar todas as janelas de manutenção

ID da operação:: GetV1Maintenancewindows

Lista todas as janelas de manutenção em sua conta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

A lista de janelas de manutenção.

Itens: MaintenanceWindowList

Listar todas as variáveis de ambiente

ID da operação:: GetV1Variables

Lista todas as variáveis de ambiente atuais em sua conta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: EnvironmentVariableList

Listar todas as verificações

ID da operação:: GetV1Checks

Lista todas as verificações atuais em sua conta.

Parâmetros

Nome	Chave	Tipo	Description
Limit	limit	integer	Limite o número de resultados.
Número	page	number	O número da página.
Filtro de URL de Verificação de API	apiCheckUrlFilterPattern	string	Filtra os resultados por uma cadeia de caracteres contida na URL de uma verificação de API, por exemplo, um domínio como www.myapp.com. Retorna apenas verificações de API.

Retornos

Itens: CheckList

Listar todos os alertas para sua conta

ID da operação:: GetV1Checkalerts

Lista todos os alertas para sua conta.

Parâmetros

Nome	Chave	Tipo	Description
Limit	limit	integer	Limite o número de resultados.
Número	page	number	O número da página.
De	from	date	Selecione documentos acima deste carimbo de data/hora UNIX (>= data). O padrão é agora - 6 horas.
Para	to	date	Selecione alertas até este carimbo de data/hora UNIX (< data). O padrão é de 6 horas depois.

Retornos

Itens: CheckAlertList

Listar todos os canais de alerta

ID da operação:: GetV1Alertchannels

Lista todos os canais de alerta configurados e suas verificações assinadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: AlertChannelList

Listar todos os grupos de verificação

ID da operação:: GetV1Checkgroups

Lista todos os grupos de verificação atuais em sua conta. A propriedade checks é uma matriz de verificação de UUID's para referência conveniente. Ele é somente leitura e você não pode usá-lo para adicionar verificações a um grupo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: CheckGroupList

Listar todos os locais privados

ID da operação:: GetV1Privatelocations

Lista todos os locais privados em sua conta.

Retornos

Itens: privateLocationsListSchema

Listar todos os painéis

ID da operação:: GetV1Dashboards

Lista todos os painéis atuais em sua conta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: DashboardsList

Listar todos os snippets

ID da operação:: GetV1Snippets

Lista todos os snippets atuais em sua conta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: SnippetList

Listar todos os status de verificação

ID da operação:: GetV1Checkstatuses

Mostra as informações de status atuais de todas as verificações em sua conta. Os registros de status de verificação são atualizados continuamente à medida que novos resultados de verificação chegam.

Retornos

Itens: CheckStatusList

Mostra detalhes de um runtime específico

ID da operação:: GetV1RuntimesId

Mostra os detalhes de todos os pacotes NPM incluídos e sua versão para um runtime específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Corpo: Runtime

Obter métricas de integridade de local privado de uma janela de tempo

ID da operação:: GetV1PrivatelocationsIdMetrics

Obtenha métricas de integridade de local privado de uma janela de tempo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
De	from	True	date	Selecione as métricas começando com esse carimbo de data/hora UNIX. Deve ter menos de 15 dias.
Para	to	True	date	Selecione métricas até este carimbo de data/hora UNIX.

Retornos

Corpo: privateLocationsMetricsHistoryResponseSchema

Obter o gatilho de verificação

ID da operação:: GetV1TriggersChecksCheckid

Localiza o gatilho de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Retornos

Corpo: CheckTrigger

Obter o gatilho do grupo de verificação

ID da operação:: GetV1TriggersCheckgroupsGroupid

Localiza o gatilho do grupo de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	groupId	True	integer	O identificador do grupo.

Retornos

Corpo: CheckGroupTrigger

Obter o selo de status do grupo

ID da operação:: GetV1BadgesGroupsGroupid

Obtenha o selo de status do grupo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	groupId	True	integer	O identificador do grupo.
Estilo	style		string	O estilo.
Tema	theme		string	O tema.
Tempo de resposta	responseTime		boolean	O tempo de resposta.

Retornos

response: string

Obter selo de status de verificação

ID da operação:: GetV1BadgesChecksCheckid

Obtenha o selo de status de verificação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Estilo	style		string	O estilo.
Tema	theme		string	O tema.
Tempo de resposta	responseTime		boolean	O tempo de resposta.

Retornos

response: string

Recuperar detalhes de status de verificação

ID da operação:: GetV1CheckstatusesCheckid

Mostrar as informações de status atuais para uma verificação específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Retornos

Corpo: CheckStatus

Recuperar todas as verificações em um grupo específico com as configurações de grupo aplicadas

ID da operação:: GetV1CheckgroupsIdChecks

Lista todas as verificações em um grupo de verificação específico com as configurações de grupo aplicadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.
Limit	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Retornos

Itens: Model8

Recuperar um canal de alerta

ID da operação:: GetV1AlertchannelsId

Mostrar detalhes de um canal de alerta específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Retornos

Corpo: AlertChannel

Recuperar um grupo de verificação

ID da operação:: GetV1CheckgroupsId

Mostrar detalhes de um grupo de verificação específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Retornos

Corpo: CheckGroup

Recuperar um local privado

ID da operação:: GetV1PrivatelocationsId

Mostrar detalhes de um local privado específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Corpo: privatelocationschema

Recuperar um resultado de verificação

ID da operação:: GetV1CheckresultsCheckidCheckresultid

Mostrar detalhes de um resultado de verificação específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Verificar A ID do Resultado	checkResultId	True	string	O identificador de resultado de verificação.

Retornos

Corpo: CheckResult

Recuperar um snippet

ID da operação:: GetV1SnippetsId

Mostrar detalhes de um snippet específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Retornos

Corpo: Snippet

Recuperar uma janela de manutenção

ID da operação:: GetV1MaintenancewindowsId

Mostrar detalhes de uma janela de manutenção específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	integer	O identificador.

Retornos

Corpo: MaintenanceWindow

Recuperar uma variável de ambiente

ID da operação:: GetV1VariablesKey

Mostrar detalhes de uma variável de ambiente específica. Usa o campo de chave para seleção.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Key	key	True	string	A chave.

Retornos

Corpo: EnvironmentVariable

Recuperar uma verificação

ID da operação:: GetV1ChecksId

Mostrar detalhes de uma API específica ou verificação de navegador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Corpo: Check

Recuperar uma verificação em um grupo específico com as configurações de grupo aplicadas

ID da operação:: GetV1CheckgroupsGroupidChecksCheckid

Mostrar detalhes de uma verificação em um grupo de verificação específico com as configurações de grupo aplicadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do grupo	groupId	True	integer	O identificador do grupo.
Verificar ID	checkId	True	string	O identificador de verificação.

Retornos

Corpo: CheckGroupCheck

Remover um local privado

ID da operação:: DeleteV1PrivatelocationsId

Remove permanentemente um local privado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Remover uma chave de API existente para um local privado

ID da operação:: DeleteV1PrivatelocationsIdKeysKeyid

Remove permanentemente uma chave de api de um local privado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
ID da chave	keyId	True	string	O identificador de chave.

Definições

AlertChannelConfig

A configuração do canal de alerta.

Nome	Caminho	Tipo	Description
Configuração do Canal de Alerta		object	A configuração do canal de alerta.

AlertChanelSubscription

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Verificar ID	checkId	guid	O identificador de verificação.
ID do grupo	groupId	number	O identificador do grupo.
Activated	activated	boolean	Se ativado.

AlertChanelSubscriptionList

Todas as verificações assinadas neste canal.

Nome	Caminho	Tipo	Description
Itens		AlertChanelSubscription

AlertChannel

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Tipo	type	string	O tipo de canal de alerta, ou seja, EMAIL ou SLACK.
Configuração do Canal de Alerta	config	AlertChannelConfig	A configuração do canal de alerta.
Lista de Assinaturas do Canal de Alerta	subscriptions	AlertChanelSubscriptionList	Todas as verificações assinadas neste canal.
Enviar Recuperação	sendRecovery	boolean	Se enviar recuperação.
Falha de envio	sendFailure	boolean	Se a falha de envio.
Enviar degradado	sendDegraded	boolean	Se o envio foi degradado.
Expiração do SSL	sslExpiry	boolean	Determina se um alerta deve ser enviado para certificados SSL expirando.
Limite de expiração do SSL	sslExpiryThreshold	integer	Em que momento começar a alertar sobre certificados SSL.
Criado em	created_at	date-time	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

AlertChannelList

Nome	Caminho	Tipo	Description
Itens		AlertChannel

CheckAlert

Nome	Caminho	Tipo	Description
ID	id	string	O identificador exclusivo desse alerta.
Nome	name	string	O nome da verificação.
Verificar ID	checkId	string	O identificador de verificação ao qual este alerta pertence.
Tipo de alerta	alertType	string	O tipo de alerta.
Tipo de verificação	checkType	string	O tipo da verificação.
Local de execução	runLocation	string	De qual local de data center esse alerta de verificação foi disparado.
Tempo de resposta	responseTime	number	Descreve o tempo necessário para executar partes relevantes dessa verificação. Qualquer tempo de sistema de temporizador de configuração necessário para começar a executar essa verificação no back-end checkly não faz parte disso.
Erro	error	string	Todas as mensagens de erro específicas que faziam parte da verificação de falha disparando o alerta.
Código de status	statusCode	string	O código de status da resposta. Aplica-se somente a verificações de API.
Criado em	created_at	date	A data e a hora em que esse alerta de verificação foi criado.
Iniciado em	startedAt	date	A data e a hora em que esse alerta de verificação foi iniciado.

CheckAlertList

Nome	Caminho	Tipo	Description
Itens		CheckAlert

CheckGroupTagList

Marcas para organizar e filtrar verificações.

Nome	Caminho	Tipo	Description
Itens		string

CheckGroupLocationList

Uma matriz de um ou mais locais de data center onde executar as verificações.

Nome	Caminho	Tipo	Description
Itens		string

KeyValue

Nome	Caminho	Tipo	Description
Key	key	string	A chave.
Value	value	string	O valor.
Bloqueado	locked	boolean	Se está bloqueado.

HeaderList

Nome	Caminho	Tipo	Description
Itens		KeyValue

QueryParameterList

Nome	Caminho	Tipo	Description
Itens		KeyValue

Asserção

Nome	Caminho	Tipo	Description
Source	source	string	A origem.
Propriedade	property	string	A propriedade.
Comparison	comparison	string	A comparação.
Meta	target	string	O destino.

AssertionList

Verifique a documentação principal checkly sobre declarações para valores específicos, como expressões regulares e descritores de caminho JSON que você pode usar no campo de propriedade.

Nome	Caminho	Tipo	Description
Itens		Assertion

BasicAuth

Nome	Caminho	Tipo	Description
Nome de usuário	username	string	O nome de usuário.
Senha	password	string	A senha.

CheckGroupAPICheckDefaults

Nome	Caminho	Tipo	Description
URL	url	string	A URL base desse grupo que você pode referenciar com a variável {{GROUP_BASE_URL}} em todas as verificações de grupo.
headers	headers	HeaderList
queryParameters	queryParameters	QueryParameterList
Lista de declarações	assertions	AssertionList	Verifique a documentação principal checkly sobre declarações para valores específicos, como expressões regulares e descritores de caminho JSON que você pode usar no campo de propriedade.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

Os padrões de verificação do navegador do grupo de verificação.

Nome	Caminho	Tipo	Description
Verificar padrões de verificação do navegador de grupo		object	Os padrões de verificação do navegador do grupo de verificação.

EnvironmentVariable

Nome	Caminho	Tipo	Description
Key	key	string	A chave da variável de ambiente (esse valor não pode ser alterado).
Value	value	string	O valor da variável de ambiente.
Bloqueado	locked	boolean	Usado apenas na interface do usuário para ocultar o valor como uma senha.

EnvironmentVariableList

Nome	Caminho	Tipo	Description
Itens		EnvironmentVariable

AlertSettingsRunBasedEscalation

Nome	Caminho	Tipo	Description
Limite de execução com falha	failedRunThreshold	number	Após a falha da verificação consecutiva, uma notificação de alerta deve ser enviada.

AlertSettingsTimeBasedEscalation

Nome	Caminho	Tipo	Description
Limite de falha de minutos	minutesFailingThreshold	number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.

AlertSettingsReminders

Nome	Caminho	Tipo	Description
Quantidade	amount	number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval	number	Em que intervalo os lembretes devem ser enviados.

AlertSettingsSSLCertificates

[PRETERIDO] sslCertificates é preterido e não é mais usado. Ignore-o e será removido em uma versão futura.

Nome	Caminho	Tipo	Description
Enabled	enabled	boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL expirando.
Limite de alerta	alertThreshold	integer	Em que momento começar a alertar sobre certificados SSL.

CheckGroupAlertSettings

Configurações de alerta.

Nome	Caminho	Tipo	Description
Tipo de escalonamento	escalationType	string	Determina que tipo de escalonamento usar.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Lembretes	reminders	AlertSettingsReminders
Certificados SSL de configurações de alerta	sslCertificates	AlertSettingsSSLCertificates	[PRETERIDO] `sslCertificates` é preterido e não é mais usado. Ignore-o e será removido em uma versão futura.

Model1

Assinatura do canal de alerta.

Nome	Caminho	Tipo	Description
ID do Canal de Alerta	alertChannelId	number	O identificador do canal de alerta.
Activated	activated	boolean	Se ativado.

AlertChannelSubscriptionCreateList

Lista de assinaturas de canal de alerta.

Nome	Caminho	Tipo	Description
Assinatura do Canal de Alerta		Model1	Assinatura do canal de alerta.

privateLocations

Uma matriz de um ou mais locais privados onde executar a verificação.

Nome	Caminho	Tipo	Description
Itens		string

Grupo de Verificação

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Nome	name	string	O nome do grupo de verificação.
Activated	activated	boolean	Determina se as verificações no grupo estão em execução ou não.
Abafado	muted	boolean	Determina se as notificações serão enviadas quando um check-in desse grupo falhar e/ou se recuperar.
Verificar lista de marcas de grupo	tags	CheckGroupTagList	Marcas para organizar e filtrar verificações.
Verificar a lista de localização do grupo	locations	CheckGroupLocationList	Uma matriz de um ou mais locais de data center onde executar as verificações.
Concurrency	concurrency	number	Determina quantas verificações são invocadas simultaneamente ao disparar um grupo de verificação de CI/CD ou por meio da API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Verificar padrões de verificação do navegador de grupo	browserCheckDefaults	CheckGroupBrowserCheckDefaults	Os padrões de verificação do navegador do grupo de verificação.
environmentVariables	environmentVariables	EnvironmentVariableList
Verificação dupla	doubleCheck	boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Usar configurações de alerta global	useGlobalAlertSettings	boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida neste grupo de verificação.
Verificar configurações de alerta de grupo	alertSettings	CheckGroupAlertSettings	Configurações de alerta.
Lista de criação de assinatura do canal de alerta	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Lista de assinaturas de canal de alerta.
Configurar a ID do snippet	setupSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API nesse grupo.
ID do snippet de demolição	tearDownSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API nesse grupo.
Script de instalação local	localSetupScript	string	Uma parte válida do código Node.js a ser executada na fase de instalação de uma verificação de API neste grupo.
Script de demolição local	localTearDownScript	string	Uma parte válida do código Node.js a ser executada na fase de teardown de uma verificação de API neste grupo.
Runtime ID	runtimeId	string	A versão de runtime, ou seja, conjunto fixo de dependências de runtime, usado para executar verificações nesse grupo.
Locais Privados	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckGroupList

Nome	Caminho	Tipo	Description
Itens		CheckGroup

CheckLocationList

Uma matriz de um ou mais locais de data center onde executar essa verificação.

Nome	Caminho	Tipo	Description
Itens		string

CheckTagList

Marcas para organizar e filtrar verificações.

Nome	Caminho	Tipo	Description
Itens		string

CheckAlertSettings

Configurações de alerta.

Nome	Caminho	Tipo	Description
Tipo de escalonamento	escalationType	string	Determina que tipo de escalonamento usar.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Lembretes	reminders	AlertSettingsReminders
Certificados SSL de configurações de alerta	sslCertificates	AlertSettingsSSLCertificates	[PRETERIDO] `sslCertificates` é preterido e não é mais usado. Ignore-o e será removido em uma versão futura.

CheckAlertChannelSubscription

Nome	Caminho	Tipo	Description
ID do Canal de Alerta	alertChannelId	number	O identificador do canal de alerta.
Activated	activated	boolean	Se ativado.

CheckAlertChannelSubscriptionList

Nome	Caminho	Tipo	Description
Itens		CheckAlertChannelSubscription

CheckRequest

A solicitação de verificação.

Nome	Caminho	Tipo	Description
Verificar Solicitação		object	A solicitação de verificação.

CheckEnvironmentVariableList

Pares chave/valor para definir variáveis de ambiente durante a execução da verificação. Elas são relevantes apenas para verificações de navegador. Use variáveis de ambiente globais sempre que possível.

Nome	Caminho	Tipo	Description
Itens		EnvironmentVariable

CheckAlertEmail

Nome	Caminho	Tipo	Description
Endereço	address	string	O endereço.

CheckAlertEmailList

Nome	Caminho	Tipo	Description
Itens		CheckAlertEmail

Model4

Nome	Caminho	Tipo	Description
Itens		KeyValue

Model5

Nome	Caminho	Tipo	Description
Itens		KeyValue

CheckAlertWebhook

Nome	Caminho	Tipo	Description
Nome	name	string	O nome.
URL	url	string	O endereço da URL.
Método	method	string	O método.
headers	headers	Model4
queryParameters	queryParameters	Model5

CheckAlertWebhookList

Nome	Caminho	Tipo	Description
Itens		CheckAlertWebhook

CheckAlertSlack

Nome	Caminho	Tipo	Description
URL	url	string	O endereço da URL.

CheckAlertSlackList

Nome	Caminho	Tipo	Description
Itens		CheckAlertSlack

CheckAlertSMS

Nome	Caminho	Tipo	Description
Número	number	string	O número.
Nome	name	string	O nome.

CheckAlertSMSList

Nome	Caminho	Tipo	Description
Itens		CheckAlertSMS

CheckAlertChannels

Nome	Caminho	Tipo
email	email	CheckAlertEmailList
webhook	webhook	CheckAlertWebhookList
folga	slack	CheckAlertSlackList
mensagem de texto	sms	CheckAlertSMSList

CheckGroupCheck

Nome	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Activated	activated	boolean	Determina se a verificação está em execução ou não.
Abafado	muted	boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck	boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations	CheckLocationList	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags	CheckTagList	Marcas para organizar e filtrar verificações.
Verificar configurações de alerta	alertSettings	CheckAlertSettings	Configurações de alerta.
Usar configurações de alerta global	useGlobalAlertSettings	boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId	number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId	string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo da verificação.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset	integer	O deslocamento de frequência.
Verificar Solicitação	request	CheckRequest	A solicitação de verificação.
Script	script	string	O script.
Verificar lista de variáveis de ambiente	environmentVariables	CheckEnvironmentVariableList	Pares chave/valor para definir variáveis de ambiente durante a execução da verificação. Elas são relevantes apenas para verificações de navegador. Use variáveis de ambiente globais sempre que possível.
Configurar a ID do snippet	setupSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
ID do snippet de demolição	tearDownSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Script de instalação local	localSetupScript	string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript	string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
alertChannels	alertChannels	CheckAlertChannels
Locais Privados	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

Model8

Nome	Caminho	Tipo	Description
Itens		CheckGroupCheck

Declarações

Lista de asserções de verificação de API.

Nome	Caminho	Tipo	Description
Itens		string

headers

Os cabeçalhos.

Nome	Caminho	Tipo	Description
Headers		object	Os cabeçalhos.

parâmetros

Os parâmetros.

Nome	Caminho	Tipo	Description
Params		object	Os parâmetros.

solicitação

A solicitação para a API.

Nome	Caminho	Tipo	Description
método	method	string
url	url	string
dados	data	string
Headers	headers	headers	Os cabeçalhos.
Params	params	params	Os parâmetros.

Horários

Os tempos.

Nome	Caminho	Tipo	Description
Horários		object	Os tempos.

timingPhases

As fases de tempo.

Nome	Caminho	Tipo	Description
Fases de tempo		object	As fases de tempo.

response

A resposta da API.

Nome	Caminho	Tipo	Description
Situação	status	number	O status.
Texto de status	statusText	string	O texto de status.
Corpo	body	string	O corpo.
Headers	headers	headers	Os cabeçalhos.
Horários	timings	timings	Os tempos.
Fases de tempo	timingPhases	timingPhases	As fases de tempo.

jobLog

O log de trabalhos.

Nome	Caminho	Tipo	Description
Log de trabalhos		object	O log de trabalhos.

jobAssets

Ativos gerados a partir da execução de verificação.

Nome	Caminho	Tipo	Description
Itens		string

CheckResultAPI

Os dados de resposta de uma verificação de API.

Nome	Caminho	Tipo	Description
Assertions	assertions	assertions	Lista de asserções de verificação de API.
Solicitação	request	request	A solicitação para a API.
Resposta	response	response	A resposta da API.
Erro de solicitação	requestError	string	Descreve se ocorreu um erro na solicitação.
Log de trabalhos	jobLog	jobLog	O log de trabalhos.
Ativos de trabalho	jobAssets	jobAssets	Ativos gerados a partir da execução de verificação.

Erros

Lista de erros na execução de verificação.

Nome	Caminho	Tipo	Description
Itens		string

Model9

Verifique os resultados do log de execução.

Nome	Caminho	Tipo	Description
Itens		string

traceSummary

O resumo do rastreamento.

Nome	Caminho	Tipo	Description
Resumo do rastreamento		object	O resumo do rastreamento.

Páginas

Lista de páginas usadas na execução de verificação.

Nome	Caminho	Tipo	Description
Itens		string

CheckResultBrowser

Os dados de resposta de uma verificação do navegador.

Nome	Caminho	Tipo	Description
Tipo	type	string	O tipo de estrutura que a verificação está usando.
Errors	errors	errors	Lista de erros na execução de verificação.
Hora de Término	endTime	number	Hora de término da execução da verificação.
Hora de Início	startTime	number	Hora de início da execução da verificação.
Versão do runtime	runtimeVersion	string	Versão do runtime ativo.
Verificar log de execução	jobLog	Model9	Verifique os resultados do log de execução.
Ativos de trabalho	jobAssets	jobAssets	Ativos gerados a partir da execução de verificação.
Resumo do rastreamento	traceSummary	traceSummary	O resumo do rastreamento.
Páginas	pages	pages	Lista de páginas usadas na execução de verificação.

CheckResult

Nome	Caminho	Tipo	Description
ID	id	string	O identificador exclusivo desse resultado.
Nome	name	string	O nome da verificação.
Verificar ID	checkId	string	O identificador da verificação.
Tem falhas	hasFailures	boolean	Descreve se ocorreu alguma falha durante essa execução de verificação. Esse deve ser o foco principal para avaliar o comportamento de verificação da API ou do navegador. Asserções que falham, tempos limite ou scripts com falha resolvem que esse valor é verdadeiro.
Tem erros	hasErrors	boolean	Descreve se ocorreu um erro interno no back-end de Checkly. Isso deve ser falso em quase todos os casos.
Está degradado	isDegraded	boolean	Uma verificação será degradada se estiver acima do limite de degradação definido pelo campo degradadoResponseTime na verificação. Aplica-se somente a verificações de API.
Tempo máximo de resposta	overMaxResponseTime	boolean	Defina como true se o tempo de resposta estiver acima do limite definido pelo campo maxResponseTime na verificação. Aplica-se somente a verificações de API.
Local de execução	runLocation	string	De qual local de data center esse resultado de verificação se originou.
Iniciado em	startedAt	date-time	O iniciado no momento.
Parado em	stoppedAt	date-time	A parada no momento.
Criado em	created_at	date-time	Quando criado em.
Tempo de resposta	responseTime	number	Descreve o tempo necessário para executar partes relevantes dessa verificação. Qualquer tempo de sistema de temporizador de configuração necessário para começar a executar essa verificação no back-end checkly não faz parte disso.
Verificar a API de Resultados	apiCheckResult	CheckResultAPI	Os dados de resposta de uma verificação de API.
Resultado da verificação do navegador	browserCheckResult	CheckResultBrowser	Os dados de resposta de uma verificação do navegador.
Verificar a ID da Execução	checkRunId	number	O identificador da execução de verificação específica que criou esse resultado de verificação.
Tentativas	attempts	number	Com que frequência essa verificação foi repetida. Isso será maior que 0 quando a verificação dupla estiver habilitada.

CheckResultList

Nome	Caminho	Tipo	Description
Itens		CheckResult

CheckStatus

Nome	Caminho	Tipo	Description
Nome	name	string	O nome da verificação.
Verificar ID	checkId	string	O identificador da verificação ao qual esse status pertence.
Tem falhas	hasFailures	boolean	Descreve se essa verificação está falhando no momento. Se qualquer uma das declarações de uma API falhar, esse valor será verdadeiro. Se uma verificação de navegador falhar por qualquer motivo, isso é verdade.
Tem erros	hasErrors	boolean	Descreve se devido a algum erro fora da operação normal esta verificação está falhando. Isso deve ser extremamente raro e somente quando houver um erro no back-end checkly.
Está degradado	isDegraded	boolean	Uma verificação será degradada se estiver acima do limite de degradação definido pelo campo degradadoResponseTime na verificação. Aplica-se somente a verificações de API.
Execução mais longa	longestRun	number	O tempo de resposta mais longo já registrado para essa verificação.
Execução mais curta	shortestRun	number	O menor tempo de resposta já registrado para essa verificação.
Local da Última Execução	lastRunLocation	string	Em que local essa verificação foi executada pela última vez.
ID da última execução de verificação	lastCheckRunId	string	O identificador de incremento exclusivo para cada execução de verificação.
Dias SSL restantes	sslDaysRemaining	number	Quantos dias restam até que o certificado SSL atual expire.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckStatusList

Nome	Caminho	Tipo	Description
Itens		CheckStatus

Verificação

Nome	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Activated	activated	boolean	Determina se a verificação está em execução ou não.
Abafado	muted	boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck	boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations	CheckLocationList	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags	CheckTagList	Marcas para organizar e filtrar verificações.
Verificar configurações de alerta	alertSettings	CheckAlertSettings	Configurações de alerta.
Usar configurações de alerta global	useGlobalAlertSettings	boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId	number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId	string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo da verificação.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset	integer	O deslocamento de frequência.
Verificar Solicitação	request	CheckRequest	A solicitação de verificação.
Script	script	string	O script.
Verificar lista de variáveis de ambiente	environmentVariables	CheckEnvironmentVariableList	Pares chave/valor para definir variáveis de ambiente durante a execução da verificação. Elas são relevantes apenas para verificações de navegador. Use variáveis de ambiente globais sempre que possível.
Configurar a ID do snippet	setupSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
ID do snippet de demolição	tearDownSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Script de instalação local	localSetupScript	string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript	string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
alertChannels	alertChannels	CheckAlertChannels
Locais Privados	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckList

Nome	Caminho	Tipo	Description
Itens		Check

Model14

Nome	Caminho	Tipo	Description
Itens		KeyValue

Model15

Nome	Caminho	Tipo	Description
Itens		KeyValue

Model16

Determina a solicitação de que a verificação será executada.

Nome	Caminho	Tipo	Description
método	method	string
URL	url	string	O endereço da URL.
Seguir redirecionamentos	followRedirects	boolean	Se deseja seguir redirecionamentos.
Ignorar SSL	skipSSL	boolean	Se deseja ignorar o SSL.
Corpo	body	string	O corpo.
Tipo de corpo	bodyType	string	O tipo de corpo.
headers	headers	Model14
queryParameters	queryParameters	Model15
Lista de declarações	assertions	AssertionList	Verifique a documentação principal checkly sobre declarações para valores específicos, como expressões regulares e descritores de caminho JSON que você pode usar no campo de propriedade.
basicAuth	basicAuth	BasicAuth

CheckAPI

Nome	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Activated	activated	boolean	Determina se a verificação está em execução ou não.
Abafado	muted	boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck	boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations	CheckLocationList	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags	CheckTagList	Marcas para organizar e filtrar verificações.
Verificar configurações de alerta	alertSettings	CheckAlertSettings	Configurações de alerta.
Usar configurações de alerta global	useGlobalAlertSettings	boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId	number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId	string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Verificar Solicitação	request	Model16	Determina a solicitação de que a verificação será executada.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset	integer	Usado para definir segundos para verificar frequências em menos de 1 minuto (apenas para verificações de API) e propagar verificações em um intervalo de tempo para frequências ao longo de 1 minuto. Isso funciona da seguinte maneira: verificações com uma frequência de 0 podem ter um frequencyOffset de 10, 20 ou 30, o que significa que eles serão executados a cada 10, 20 ou 30 segundos. Verificações com uma frequência inferior e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequency * 10), ou seja, para uma verificação que é executada a cada 5 minutos, a frequência máximaOffset é 50. Verificações com uma frequência maior que 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.ceil(frequency/60), ou seja, para uma verificação que é executada a cada 720 minutos, a frequência máximaOffset é 12.
ID do snippet de demolição	tearDownSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de teardown de uma verificação de API.
Configurar a ID do snippet	setupSnippetId	number	Uma referência de identificador a um snippet a ser usado na fase de instalação de uma verificação de API.
Script de instalação local	localSetupScript	string	Uma parte válida do código Node.js a ser executada na fase de instalação.
Script de demolição local	localTearDownScript	string	Uma parte válida do código Node.js a ser executada na fase de teardown.
Tempo de resposta degradado	degradedResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada degradada.
Tempo máximo de resposta	maxResponseTime	number	O tempo de resposta em milissegundos em que uma verificação deve ser considerada falha.
Locais Privados	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
Tipo de verificação	checkType	string	O tipo de verificação.
alertChannels	alertChannels	CheckAlertChannels
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckBrowser

Nome	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Activated	activated	boolean	Determina se a verificação está em execução ou não.
Abafado	muted	boolean	Determina se as notificações serão enviadas quando uma verificação falhar e/ou se recuperar.
Verificação dupla	doubleCheck	boolean	Definir isso como true disparará uma repetição quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Caso falhe	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada como falha. Permite validar o status do erro, como 404.
Verificar Lista de Localização	locations	CheckLocationList	Uma matriz de um ou mais locais de data center onde executar essa verificação.
Verificar Lista de Marcas	tags	CheckTagList	Marcas para organizar e filtrar verificações.
Verificar configurações de alerta	alertSettings	CheckAlertSettings	Configurações de alerta.
Usar configurações de alerta global	useGlobalAlertSettings	boolean	Quando true, a configuração de alerta no nível da conta será usada, não a configuração de alerta definida nesta verificação.
ID do grupo	groupId	number	O identificador do grupo de verificação do qual essa verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição dessa verificação em um grupo de verificação. Ele determina em quais verificações de ordem são executadas quando um grupo é disparado da API ou da CI/CD.
Runtime ID	runtimeId	string	A versão de runtime, ou seja, o conjunto fixo de dependências de runtime, usado para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo de verificação.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Script	script	string	Uma parte válida de Node.js código javascript que descreve uma interação do navegador com as estruturas puppeteer ou playwright.
Locais Privados	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
alertChannels	alertChannels	CheckAlertChannels
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

DashboardTagList

Uma lista de uma ou mais marcas que filtram as verificações a serem exibidas no painel.

Nome	Caminho	Tipo	Description
Itens		string

Dashboard

Nome	Caminho	Tipo	Description
Custom Domain	customDomain	string	Um domínio de usuário personalizado, por exemplo, status.example.com. Consulte os documentos sobre como atualizar o uso de DNS e SSL.
URL personalizada	customUrl	string	Um nome de subdomínio em checklyhq.com. Precisa ser exclusivo em todos os usuários.
Logotipo	logo	string	Uma URL apontando para um arquivo de imagem.
Favicon	favicon	string	Uma URL que aponta para um arquivo de imagem usado como favicon do painel.
Link	link	string	Um link de URL para redirecionar quando o logotipo do painel é clicado.
Header	header	string	Um pedaço de texto exibido na parte superior do painel.
Description	description	string	Um trecho de texto exibido abaixo do cabeçalho ou título do painel.
Largura	width	string	Determina se a tela inteira ou o foco deve ser usado no centro.
Taxa de Atualização	refreshRate	number	Com que frequência atualizar o painel em segundos.
Paginar	paginate	boolean	Determina se a paginação está ativada ou desativada.
Taxa de Paginação	paginationRate	number	Com que frequência disparar a paginação em segundos.
Verificações por página	checksPerPage	number	Número de verificações exibidas por página.
Usar e operador	useTagsAndOperator	boolean	Quando usar o operador AND para pesquisa de marcas.
Ocultar marcas	hideTags	boolean	Mostrar ou ocultar as marcas no painel.
Lista de marcas do painel	tags	DashboardTagList	Uma lista de uma ou mais marcas que filtram as verificações a serem exibidas no painel.
ID do painel	dashboardId	string	O identificador do painel.

DashboardsList

Nome	Caminho	Tipo	Description
Itens		Dashboard

Localização

Nome	Caminho	Tipo	Description
Região	region	string	O identificador exclusivo desse local.
Nome	name	string	Nome amigável deste local.

LocationList

Nome	Caminho	Tipo	Description
Itens		Location

MaintenanceWindowTagList

Os nomes da janela de manutenção de verificações e grupos devem ser aplicados.

Nome	Caminho	Tipo	Description
Itens		string

Janela de manutenção

Nome	Caminho	Tipo	Description
ID	id	number	O identificador da janela de manutenção.
Nome	name	string	O nome da janela de manutenção.
Lista de marcas da janela de manutenção	tags	MaintenanceWindowTagList	Os nomes da janela de manutenção de verificações e grupos devem ser aplicados.
Inicia em	startsAt	date	A data de início da janela de manutenção.
Termina em	endsAt	date	A data de término da janela de manutenção.
Repetir intervalo	repeatInterval	number	O intervalo de repetição da janela de manutenção da primeira ocorrência.
Repetir Unidade	repeatUnit	string	A estratégia de repetição da janela de manutenção.
Repetir termina em	repeatEndsAt	date	A data de término em que a janela de manutenção deve parar de repetir.
Criado em	created_at	date	A data de criação da janela de manutenção.
Atualizado em	updated_at	date	A última data em que a janela de manutenção foi atualizada.

MaintenanceWindowList

A lista de janelas de manutenção.

Nome	Caminho	Tipo	Description
Itens		MaintenanceWindow

CheckAssignment

Nome	Caminho	Tipo	Description
ID	id	guid	O identificador.
Verificar ID	checkId	guid	O identificador da verificação.
ID de local privado	privateLocationId	guid	O identificador do local privado atribuído.

checkAssignments

A verificação que este local privado atribuiu.

Nome	Caminho	Tipo	Description
Itens		CheckAssignment

GroupAssignment

Nome	Caminho	Tipo	Description
ID	id	guid	O identificador.
ID do grupo	groupId	number	O identificador do grupo.
ID de local privado	privateLocationId	guid	O identificador do local privado atribuído.

groupAssignments

O grupo atribuído a esse local privado.

Nome	Caminho	Tipo	Description
Itens		GroupAssignment

privateLocationKeys

Nome	Caminho	Tipo	Description
ID	id	guid	O identificador.
Chave Bruta	rawKey	string	A chave bruta.
Chave mascarada	maskedKey	string	O valor da chave mascarada.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date	Quando atualizado em.

keys

Nome	Caminho	Tipo	Description
Itens		privateLocationKeys

privatelocationschema

Nome	Caminho	Tipo	Description
ID	id	guid	O identificador.
Nome	name	string	O nome atribuído ao local privado.
Nome da lesma	slugName	string	Nome de lesma válido.
Ícone	icon	string	O ícone de local privado.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date	Quando atualizado em.
Verificar atribuições	checkAssignments	checkAssignments	A verificação que este local privado atribuiu.
Atribuições de Grupo	groupAssignments	groupAssignments	O grupo atribuído a esse local privado.
keys	keys	keys
Visto pela última vez	lastSeen	date	A última data vista.
Contagem de agentes	agentCount	number	A contagem de agentes.

privateLocationsListSchema

Nome	Caminho	Tipo	Description
Itens		privatelocationschema

commonPrivateLocationSchemaResponse

Nome	Caminho	Tipo	Description
ID	id	guid	O identificador.
Nome	name	string	O nome atribuído ao local privado.
Nome da lesma	slugName	string	Nome de lesma válido.
Ícone	icon	string	O ícone de local privado.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date	Quando atualizado em.
Verificar atribuições	checkAssignments	checkAssignments	A verificação que este local privado atribuiu.
Atribuições de Grupo	groupAssignments	groupAssignments	O grupo atribuído a esse local privado.
keys	keys	keys

Timestamps

Nome	Caminho	Tipo	Description
Timestamp		date-time	O carimbo de data/hora.

queueSize

O tamanho da fila.

Nome	Caminho	Tipo	Description
Itens		number

oldestScheduledCheckRun

Nome	Caminho	Tipo	Description
Itens		number

privateLocationsMetricsHistoryResponseSchema

Nome	Caminho	Tipo	Description
Timestamps	timestamps	timestamps
Tamanho da Fila	queueSize	queueSize	O tamanho da fila.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Marque marcas.

Nome	Caminho	Tipo	Description
Itens		string

ReportingAggregate

Nome	Caminho	Tipo	Description
Taxa de êxito	successRatio	number	Taxa de êxito da verificação sobre o intervalo de datas selecionado. A porcentagem está na forma decimal.
Mediana	avg	number	Tempo médio de resposta da verificação sobre o intervalo de datas selecionado em milissegundos.
P95	p95	number	Tempo de resposta P95 da verificação sobre o intervalo de datas selecionado em milissegundos.
P99	p99	number	Tempo de resposta P99 da verificação sobre o intervalo de datas selecionado em milissegundos.

Reportagem

Nome	Caminho	Tipo	Description
Nome	name	string	Nome da verificação.
Verificar ID	checkId	string	Verifique a ID.
Tipo de verificação	checkType	string	Tipo de verificação.
Desativado	deactivated	boolean	Verifique a desativação.
Lista de Marcas de Relatórios	tags	ReportingTagList	Marque marcas.
agregação	aggregate	ReportingAggregate

ReportingList

Nome	Caminho	Tipo	Description
Itens		Reporting

Runtime

Nome	Caminho	Tipo	Description
Nome	name	string	O nome exclusivo desse runtime.
Etapa	stage	string	Estágio de vida atual de um runtime.
Fim da vida útil do runtime	runtimeEndOfLife	string	Data em que um runtime será removido de nossa plataforma.
Padrão	default	boolean	Indica se esse é o runtime padrão atual fornecido por Checkly.
Description	description	string	Uma descrição curta e legível humana das principais atualizações neste runtime.
String	dependencies.string	string	A cadeia de caracteres.

RuntimeList

Nome	Caminho	Tipo	Description
Itens		Runtime

Fragmento

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Nome	name	string	O nome do snippet.
Script	script	string	Seu Node.js código que interage com o ciclo de vida de verificação de API ou funciona como parcial para verificações do navegador.
Criado em	created_at	date-time	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

SnippetList

Nome	Caminho	Tipo	Description
Itens		Snippet

CheckGroupTrigger

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Símbolo	token	string	O token.
Criado em	created_at	date	Quando criado em.
Chamado em	called_at	date	Quando chamado.
Atualizado em	updated_at	date	Quando atualizado em.
ID do grupo	groupId	number	O identificador do grupo.

CheckTrigger

Nome	Caminho	Tipo	Description
ID	id	number	O identificador.
Símbolo	token	string	O token.
Criado em	created_at	date	Quando criado em.
Chamado em	called_at	date	Quando chamado.
Atualizado em	updated_at	date	Quando atualizado em.
Verificar ID	checkId	string	O identificador de verificação.

objeto

Esse é o tipo 'object'.

cadeia

Esse é o tipo de dados básico 'string'.

Compartilhar via

Checkly (Independent Publisher) (Versão prévia)

Criando uma conexão

Padrão

Limitações

Ações

Atualizar as assinaturas de um canal de alerta

Parâmetros

Retornos

Atualizar um canal de alerta

Parâmetros

Retornos

Atualizar um grupo de verificação

Parâmetros

Retornos

Atualizar um local privado

Parâmetros

Retornos

Atualizar um painel

Parâmetros

Retornos

Atualizar um snippet

Parâmetros

Retornos

Atualizar uma janela de manutenção

Parâmetros

Retornos

Atualizar uma variável de ambiente

Parâmetros

Retornos

Atualizar uma verificação [PRETERIDA]

Parâmetros

Retornos

Atualizar uma verificação de API

Parâmetros

Retornos

Atualizar uma verificação do navegador

Parâmetros

Retornos

Criar o gatilho de verificação

Parâmetros

Retornos

Criar o gatilho do grupo de verificação

Parâmetros

Retornos

Criar um canal de alerta

Parâmetros

Retornos

Criar um grupo de verificação

Parâmetros

Retornos

Criar um local privado

Parâmetros

Retornos

Criar um painel de controle

Parâmetros

Retornos

Criar um snippet

Parâmetros

Retornos

Criar uma janela de manutenção

Parâmetros

Retornos

Criar uma variável de ambiente

Parâmetros

Retornos

Criar uma verificação [PRETERIDA]

Parâmetros

Retornos

Criar uma verificação de API

Parâmetros

Retornos

Criar uma verificação do navegador

Parâmetros

Retornos

Excluir o gatilho de verificação

Parâmetros

Excluir o gatilho do grupo de verificação

Parâmetros

Excluir um canal de alerta