Checkly (Editora Independente) (Pré-visualização)

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

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Troia Taylor
Sítio Web	https://www.checklyhq.com/
Política de privacidade	https://www.checklyhq.com/privacy
Categorias	Operações de TI

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
ID da conta	securestring	O ID da conta para esta API.	Verdade
API Key (no formato 'Bearer apiKey')	securestring	A chave API (no formato 'Bearer apiKey') para esta api	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar as subscrições 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 alertas de falha e recuperação sejam enviados para essa verificação. Nota: 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 painel	Atualiza um painel. Retornará um 409 ao tentar criar um painel com uma URL personalizada ou domínio personalizado que já foi usado.
Atualizar um trecho	Atualiza um trecho.
Atualizar uma janela de manutenção	Atualiza uma janela de manutenção.
Atualizar uma localização privada	Atualiza um local privado.
Atualizar uma variável de ambiente	Atualiza uma variável de ambiente. Usa o campo de chave como identificador para atualização. Atualiza apenas o valor e a propriedade bloqueada.
Atualizar uma verificação [DEPRECATED]	[PRETERIDO] Este ponto final 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 de grupo de verificação.
Criar um canal de alerta	Cria um novo canal de alerta.
Criar um dashboard	Cria um novo painel. Retornará um 409 ao tentar criar um painel com uma URL personalizada ou domínio personalizado que já foi usado.
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 snippet	Cria um novo trecho.
Criar uma janela de manutenção	Cria uma nova janela de manutenção.
Criar uma localização privada	Cria um novo local privado.
Criar uma variável de ambiente	Cria uma nova variável de ambiente.
Criar uma verificação [DEPRECATED]	[PRETERIDO] Este ponto final 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 utilizar o `globalAlertSettings`, pode `alertSettings` 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 utilizar o `globalAlertSetting`, pode `alertSetting` 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 utilizar o `globalAlertSetting`, pode `alertSetting` ser `null`
Eliminar um dashboard	Remove permanentemente um painel.
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 grupo de verificação	Remove permanentemente um grupo de verificação. Não é possível excluir um grupo de verificação se ele ainda contiver verificações.
Excluir um trecho	Remove permanentemente um trecho.
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 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 agregadas 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 do 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 suportados	Lista todos os locais suportados.
Lista todos os resultados da verificação	Lista os resultados completos e brutos da verificação para uma verificação específica. Mantemos os resultados brutos durante 30 dias. Após 30 dias 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 parâmetros e `from` para especificar um intervalo de datas (carimbo `to` 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 forem definidos parâmetros de e para parámetros, estes devem ter um intervalo máximo de seis horas. Se nenhum for definido, vamos considerar o para ser agora e de param para ser seis horas mais cedo. Se apenas o to param for definido, definiremos a partir de seis horas mais cedo. Pelo contrário, se apenas o de param for definido, consideraremos que o de param é seis horas depois. A limitação de taxa é aplicada a este ponto de extremidade, você pode enviar 5 solicitações / 10 segundos no máximo.
Lista todos os tempos de execução suportados	Lista todos os tempos de execução suportados e os pacotes NPM incluídos para verificações do navegador e scripts de configuração e desmontagem 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 na sua conta.
Listar todas as variáveis de ambiente	Lista todas as variáveis de ambiente atuais na sua conta.
Listar todas as verificações	Lista todos os cheques atuais na sua conta.
Listar todos os alertas para a sua conta	Lista todos os alertas para a sua conta.
Listar todos os canais de alerta	Lista todos os canais de alerta configurados e suas verificações inscritas.
Listar todos os grupos de verificação	Lista todos os grupos de verificação atuais na sua conta. A propriedade checks é uma matriz de UUID de verificação 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 na sua conta.
Listar todos os painéis	Lista todos os painéis atuais na sua conta.
Listar todos os status de verificação	Mostra as informações de status atuais de todas as verificações na sua conta. Os registros de status de verificação são atualizados continuamente à medida que novos resultados de verificação chegam.
Listar todos os trechos	Lista todos os trechos atuais na sua conta.
Mostra detalhes para um tempo de execução específico	Mostra os detalhes de todos os pacotes NPM incluídos e sua versão para um tempo de execução específico.
Obtenha métricas de integridade de locais privados a partir de uma janela de tempo	Obtenha métricas de integridade de locais privados a partir 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 selo de status de verificação	Obter selo de status de verificação.
Obter selo de status do grupo	Obtenha o selo de status do grupo.
Recuperar detalhes do status da 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 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 check-in em um grupo específico com 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.
Recuperar um cheque	Mostrar detalhes de uma verificação específica da API ou do navegador.
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 trecho	Mostrar detalhes de um trecho 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 chave para seleção.
Remover uma chave de API existente para um local privado	Remove permanentemente uma chave api de um local privado.
Remover uma localização privada	Remove permanentemente um local privado.

Atualizar as subscrições 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 alertas de falha e recuperação sejam enviados para essa verificação. Nota: ao passar o objeto de assinatura, você só pode especificar um checkId ou um groupId, não ambos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.
Verificar ID	checkId		guid	Você pode passar um checkId ou um groupId, mas não ambos.
ID do grupo	groupId		number	Você pode passar um checkId ou um groupId, mas não ambos.
Ativado	activated	True	boolean	Se ativado.

Devoluções

Body: AlertChanelSubscription

Atualizar um canal de alerta

ID da Operação:: PutV1AlertchannelsId

Atualize um canal de alerta.

Parâmetros

Name	Chave	Necessá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 de grupo.
Ativado	activated	True	boolean	Se ativado.
Tipo	type	True	string	O tipo.
Canal de alerta Criar configuração	config	True	object	O canal de alerta cria configuração.
Enviar Recuperação	sendRecovery		boolean	Se enviar recuperação.
Falha de envio	sendFailure		boolean	Se falha de envio.
Enviar degradado	sendDegraded		boolean	Se enviar degradado.
Expiração SSL	sslExpiry		boolean	Determina se um alerta deve ser enviado para certificados SSL expirando.
Limite de expiração SSL	sslExpiryThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.

Devoluções

Body: AlertChannel

Atualizar um grupo de verificação

ID da Operação:: PutV1CheckgroupsId

Atualiza um grupo de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name		string	O nome do grupo de verificação.
Ativado	activated		boolean	Determina se as verificações no grupo estão em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando um check-in neste grupo falhar e/ou se recuperar.
Verificar Lista de Tags de Grupo	tags		array of string	Tags para organizar e filtrar verificações.
Verificar 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 acionar um grupo de verificação a partir de CI/CD ou por meio da API.
URL	url		string	A URL base para este 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.
Valor	value	True	string	O valor.
Bloqueada	locked		boolean	Se bloqueado.
Fonte	source		string	A fonte.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Target	target		string	O alvo.
Nome de utilizador	username	True	string	O nome de usuário.
Palavra-passe	password	True	string	A senha.
Verificar Grupo Criar Browser Verificar Padrões	browserCheckDefaults		object	O grupo de verificação cria padrões de verificação do navegador.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usado para executar verificações neste grupo.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa 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 de nível de conta será usada, não a configuração de alerta definida neste grupo de verificação.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API neste grupo.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API neste grupo.
Script de configuração local	localSetupScript		string	Uma parte válida de Node.js código a ser executado na fase de configuração de uma verificação de API neste grupo.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código a ser executado na fase de desmontagem de uma verificação de API neste grupo.
Verifique os locais privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar as verificações.

Devoluções

Body: CheckGroup

Atualizar um painel

ID da Operação:: PutV1DashboardsDashboardid

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	dashboardId	True	string	O identificador do painel.
URL personalizado	customUrl		string	Um nome de subdomínio em checklyhq.com. Precisa ser único 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 seu uso de DNS e SSL.
Logótipo	logo		string	Um URL apontando para um arquivo de imagem.
ícone de favorito	favicon		string	Um URL apontando para um arquivo de imagem usado como dashboard favicon.
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 pedaço de texto exibido abaixo do cabeçalho ou título do seu painel.
Largura	width		string	Determina se a tela inteira deve ser usada ou o foco no centro.
Taxa de atualização	refreshRate		number	Com que frequência atualizar o painel em segundos.
Paginato	paginate		boolean	Determina se a paginação está ativada ou desativada.
Taxa de paginação	paginationRate		number	Com que frequência acionar a paginação em segundos.
Verificações por Página	checksPerPage		number	Número de cheques exibidos por página.
Uso E Operador	useTagsAndOperator		boolean	Quando usar o operador AND para pesquisa de tags.
Ocultar tags	hideTags		boolean	Mostrar ou ocultar as tags no painel.
Lista de tags do painel	tags		array of string	Uma lista de uma ou mais tags que filtram as verificações para exibição no painel.

Devoluções

Body: Dashboard

Atualizar um trecho

ID da Operação:: PutV1SnippetsId

Atualiza um trecho.

Parâmetros

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

Devoluções

Body: Snippet

Atualizar uma janela de manutenção

ID da Operação:: PutV1MaintenancewindowsId

Atualiza uma janela de manutenção.

Parâmetros

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

Devoluções

Body: MaintenanceWindow

Atualizar uma localização privada

ID da Operação:: PutV1PrivatelocationsId

Atualiza um local privado.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Body: commonPrivateLocationSchemaResponse

Atualizar uma variável de ambiente

ID da Operação:: PutV1VariablesKey

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Key	key	True	string	A chave.
Key	key		string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.

Devoluções

Body: EnvironmentVariable

Atualizar uma verificação [DEPRECATED]

ID da Operação:: PutV1ChecksId

[PRETERIDO] Este ponto final 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

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name		string	O nome da verificação.
Ativado	activated		boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
Tipo de verificação	checkType		string	O tipo de cheque.
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 frequências de verificação inferiores a 1 minuto (apenas para verificações API) e espalhar verificações ao longo de um intervalo de tempo para frequências superiores a 1 minuto. Isso funciona da seguinte forma: Verificações com uma frequência de 0 podem ter uma frequênciaOffset de 10, 20 ou 30, o que significa que serão executadas a cada 10, 20 ou 30 segundos. Verificações com uma frequência menor e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequência * 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 superior a 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 Pedido	request	True	object	O pedido de cheque.
Script	script	True	string	O roteiro.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
Script de configuração local	localSetupScript		string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: Check

Atualizar uma verificação de API

ID da Operação:: PutV1ChecksApiId

Atualiza uma verificação de API.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name		string	O nome da verificação.
Ativado	activated		boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
método	method	True	string
URL	url	True	string	O endereço URL.
Seguir redirecionamentos	followRedirects		boolean	Se os redirecionamentos devem ser seguidos.
Ignorar SSL	skipSSL		boolean	Se deve ignorar SSL.
Body	body		string	O corpo.
Tipo de Corpo	bodyType		string	O tipo de corpo.
Key	key	True	string	A chave.
Valor	value	True	string	O valor.
Bloqueada	locked		boolean	Se bloqueado.
Fonte	source		string	A fonte.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Target	target		string	O alvo.
Nome de utilizador	username	True	string	O nome de usuário.
Palavra-passe	password	True	string	A senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para frequências de verificação inferiores a 1 minuto e distribuir verificações ao longo de um intervalo de tempo para frequências superiores a 1 minuto. Isso funciona da seguinte forma: Verificações com uma frequência de 0 podem ter uma frequênciaOffset de 10, 20 ou 30, o que significa que serão executadas a cada 10, 20 ou 30 segundos. Verificações com uma frequência menor e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequência * 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 superior a 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 configuração local	localSetupScript		string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: CheckAPI

Atualizar uma verificação do navegador

ID da Operação:: PutV1ChecksBrowserId

Atualiza uma verificação do navegador.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name		string	O nome da verificação.
Ativado	activated		boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente 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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: CheckBrowser

Criar o gatilho de verificação

ID da Operação:: PostV1TriggersChecksCheckid

Cria o gatilho de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Devoluções

Body: CheckTrigger

Criar o gatilho do grupo de verificação

ID da Operação:: PostV1TriggersCheckgroupsGroupid

Cria o gatilho de grupo de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	groupId	True	integer	O identificador de grupo.

Devoluções

Body: CheckGroupTrigger

Criar um canal de alerta

ID da Operação:: PostV1Alertchannels

Cria um novo canal de alerta.

Parâmetros

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

Devoluções

Body: AlertChannel

Criar um dashboard

ID da Operação:: PostV1Dashboards

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

Parâmetros

Name	Chave	Tipo	Description
URL personalizado	customUrl	string	Um nome de subdomínio em checklyhq.com. Precisa ser único 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 seu uso de DNS e SSL.
Logótipo	logo	string	Um URL apontando para um arquivo de imagem.
ícone de favorito	favicon	string	Um URL apontando para um arquivo de imagem usado como dashboard favicon.
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 pedaço de texto exibido abaixo do cabeçalho ou título do seu painel.
Largura	width	string	Determina se a tela inteira deve ser usada ou o foco no centro.
Taxa de atualização	refreshRate	number	Com que frequência atualizar o painel em segundos.
Paginato	paginate	boolean	Determina se a paginação está ativada ou desativada.
Taxa de paginação	paginationRate	number	Com que frequência acionar a paginação em segundos.
Verificações por Página	checksPerPage	number	Número de cheques exibidos por página.
Uso E Operador	useTagsAndOperator	boolean	Quando usar o operador AND para pesquisa de tags.
Ocultar tags	hideTags	boolean	Mostrar ou ocultar as tags no painel.
Lista de tags do painel	tags	array of string	Uma lista de uma ou mais tags que filtram as verificações para exibição no painel.

Devoluções

Body: Dashboard

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

Name	Chave	Necessário	Tipo	Description
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name	True	string	O nome do grupo de verificação.
Ativado	activated		boolean	Determina se as verificações no grupo estão em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando um check-in neste grupo falhar e/ou se recuperar.
Verificar Lista de Tags de Grupo	tags		array of string	Tags para organizar e filtrar verificações.
Verificar 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 acionar um grupo de verificação a partir de CI/CD ou por meio da API.
URL	url		string	A URL base para este 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.
Valor	value	True	string	O valor.
Bloqueada	locked		boolean	Se bloqueado.
Fonte	source		string	A fonte.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Target	target		string	O alvo.
Nome de utilizador	username	True	string	O nome de usuário.
Palavra-passe	password	True	string	A senha.
Verificar Grupo Criar Browser Verificar Padrões	browserCheckDefaults		object	O grupo de verificação cria padrões de verificação do navegador.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usado para executar verificações neste grupo.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa 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 de nível de conta será usada, não a configuração de alerta definida neste grupo de verificação.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API neste grupo.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API neste grupo.
Script de configuração local	localSetupScript		string	Uma parte válida de Node.js código a ser executado na fase de configuração de uma verificação de API neste grupo.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código a ser executado na fase de desmontagem de uma verificação de API neste grupo.
Verifique os locais privados	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar as verificações.

Devoluções

Body: CheckGroup

Criar um snippet

ID da Operação:: PostV1Snippets

Cria um novo trecho.

Parâmetros

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

Devoluções

Body: Snippet

Criar uma janela de manutenção

ID da Operação:: PostV1Maintenancewindows

Cria uma nova janela de manutenção.

Parâmetros

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

Devoluções

Body: MaintenanceWindow

Criar uma localização privada

ID da Operação:: PostV1Privatelocations

Cria um novo local privado.

Parâmetros

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

Devoluções

Body: commonPrivateLocationSchemaResponse

Criar uma variável de ambiente

ID da Operação:: PostV1Variables

Cria uma nova variável de ambiente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.

Devoluções

Body: EnvironmentVariable

Criar uma verificação [DEPRECATED]

ID da Operação:: PostV1Checks

[PRETERIDO] Este ponto final 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 utilizar o globalAlertSettings, pode alertSettings ser null

Parâmetros

Name	Chave	Necessário	Tipo	Description
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name	True	string	O nome da verificação.
Ativado	activated	True	boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
Tipo de verificação	checkType	True	string	O tipo de cheque.
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 frequências de verificação inferiores a 1 minuto (apenas para verificações API) e espalhar verificações ao longo de um intervalo de tempo para frequências superiores a 1 minuto. Isso funciona da seguinte forma: Verificações com uma frequência de 0 podem ter uma frequênciaOffset de 10, 20 ou 30, o que significa que serão executadas a cada 10, 20 ou 30 segundos. Verificações com uma frequência menor e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequência * 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 superior a 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 Pedido	request		object	O pedido de cheque.
Script	script	True	string	O roteiro.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
Script de configuração local	localSetupScript		string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: 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 utilizar o globalAlertSetting, pode alertSetting ser null

Parâmetros

Name	Chave	Necessário	Tipo	Description
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name	True	string	O nome da verificação.
Ativado	activated	True	boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
método	method	True	string
URL	url	True	string	O endereço URL.
Seguir Redirecionamentos	followRedirects		boolean	Se segue redirecionamentos.
Ignorar SSL	skipSSL		boolean	Se deve ignorar SSL.
Body	body		string	O corpo.
Tipo de corpo	bodyType		string
Key	key	True	string	A chave.
Valor	value	True	string	O valor.
Bloqueada	locked		boolean	Se bloqueado.
Fonte	source		string	A fonte.
Propriedade	property		string	A propriedade.
Comparison	comparison		string	A comparação.
Target	target		string	O alvo.
Nome de utilizador	username	True	string	O nome de usuário.
Palavra-passe	password	True	string	A senha.
Frequência	frequency		integer	Com que frequência a verificação deve ser executada em minutos.
ID do trecho de demolição	tearDownSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
ID do trecho de configuração	setupSnippetId		number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
Deslocamento de frequência	frequencyOffset		integer	Usado para definir segundos para frequências de verificação inferiores a 1 minuto e distribuir verificações ao longo de um intervalo de tempo para frequências superiores a 1 minuto. Isso funciona da seguinte forma: Verificações com uma frequência de 0 podem ter uma frequênciaOffset de 10, 20 ou 30, o que significa que serão executadas a cada 10, 20 ou 30 segundos. Verificações com uma frequência menor e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequência * 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 superior a 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 configuração local	localSetupScript		string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript		string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: 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 utilizar o globalAlertSetting, pode alertSetting ser null

Parâmetros

Name	Chave	Necessário	Tipo	Description
Alertas de atribuição automática	autoAssignAlerts		boolean	Determina se uma nova verificação será adicionada automaticamente como assinante a todos os canais de alerta existentes quando for criada.
Nome	name	True	string	O nome da verificação.
Ativado	activated	True	boolean	Determina se a verificação está em execução ou não.
Mudo	muted		boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck		boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail		boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags		array of string	Tags para organizar e filtrar verificações.
Tipo de escalonamento	escalationType		string	Determina o tipo de escalonamento a ser usado.
Limite de Execução com Falha	failedRunThreshold		number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.
Minutos com falha no limite	minutesFailingThreshold		number	Depois de quantos minutos após uma verificação começar a falhar, um alerta deve ser enviado.
Montante	amount		number	Quantos lembretes enviar após a notificação de alerta inicial.
Intervalo	interval		number	Em que intervalo os lembretes devem ser enviados.
Ativado(a)	enabled		boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold		integer	Em que momento na hora de começar a alertar sobre certificados SSL.
Usar Configurações de Alerta Global	useGlobalAlertSettings		boolean	Quando true, a configuração de alerta de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder		number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId		string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
ID do canal de alerta	alertChannelId	True	number	O identificador do canal de alerta.
Ativado	activated	True	boolean	Se ativado.
Key	key	True	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	True	string	O valor da variável de ambiente.
Bloqueada	locked		boolean	Usado somente 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.
Localizações Privadas	privateLocations		array of string	Uma matriz de um ou mais locais privados onde executar a verificação.

Devoluções

Body: CheckBrowser

Eliminar um dashboard

ID da Operação:: DeleteV1DashboardsDashboardid

Remove permanentemente um painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	dashboardId	True	string	O identificador do painel.

Excluir o gatilho de verificação

ID da Operação:: DeleteV1TriggersChecksCheckid

Exclui o gatilho de verificação.

Parâmetros

Name	Chave	Necessá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

Name	Chave	Necessário	Tipo	Description
ID do grupo	groupId	True	integer	O identificador de grupo.

Excluir um canal de alerta

ID da Operação:: DeleteV1AlertchannelsId

Remove permanentemente um canal de alerta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Excluir um grupo de verificação

ID da Operação:: DeleteV1CheckgroupsId

Remove permanentemente um grupo de verificação. Não é possível excluir um grupo de verificação se ele ainda contiver verificações.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Excluir um trecho

ID da Operação:: DeleteV1SnippetsId

Remove permanentemente um trecho.

Parâmetros

Name	Chave	Necessá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

Name	Chave	Necessá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 identificador para exclusão.

Parâmetros

Name	Chave	Necessá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

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Gera um relatório com estatísticas agregadas 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

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

Devoluções

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 do navegador específica em uma janela de tempo especificada.

Parâmetros

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

Devoluções

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

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Body: privateLocationKeys

Lista todos os locais suportados

ID da Operação:: GetV1Locations

Lista todos os locais suportados.

Devoluções

Itens: LocationList

Lista todos os resultados da verificação

ID da Operação:: GetV1CheckresultsCheckid

Lista os resultados completos e brutos da verificação para uma verificação específica. Mantemos os resultados brutos durante 30 dias. Após 30 dias 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 parâmetros e from para especificar um intervalo de datas (carimbo to 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 forem definidos parâmetros de e para parámetros, estes devem ter um intervalo máximo de seis horas. Se nenhum for definido, vamos considerar o para ser agora e de param para ser seis horas mais cedo. Se apenas o to param for definido, definiremos a partir de seis horas mais cedo. Pelo contrário, se apenas o de param for definido, consideraremos que o de param é seis horas depois. A limitação de taxa é aplicada a este ponto de extremidade, você pode enviar 5 solicitações / 10 segundos no máximo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.
De	from		date	Selecione documentos a partir deste carimbo de data/hora UNIX (>= data). O padrão é agora - 6 horas.
Para	to		date	Selecione alertas até este carimbo de data/hora do UNIX (< data). O padrão é 6 horas após a partir de.
Localização	location		string	Fornecer uma localização de centro de dados, por exemplo, eu-west-1 para filtrar por localização
Tipo de verificação	checkType		string	O tipo de cheque.
Tem falhas	hasFailures		boolean	O resultado da verificação tem uma ou mais falhas.

Devoluções

Itens: CheckResultList

Lista todos os tempos de execução suportados

ID da Operação:: GetV1Runtimes

Lista todos os tempos de execução suportados e os pacotes NPM incluídos para verificações do navegador e scripts de configuração e desmontagem para verificações de API.

Devoluções

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

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

Devoluções

Itens: CheckAlertList

Listar todas as janelas de manutenção

ID da Operação:: GetV1Maintenancewindows

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

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 na sua conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

Itens: EnvironmentVariableList

Listar todas as verificações

ID da Operação:: GetV1Checks

Lista todos os cheques atuais na sua conta.

Parâmetros

Name	Chave	Tipo	Description
Limite	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.

Devoluções

Itens: CheckList

Listar todos os alertas para a sua conta

ID da Operação:: GetV1Checkalerts

Lista todos os alertas para a sua conta.

Parâmetros

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

Devoluções

Itens: CheckAlertList

Listar todos os canais de alerta

ID da Operação:: GetV1Alertchannels

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

Itens: AlertChannelList

Listar todos os grupos de verificação

ID da Operação:: GetV1Checkgroups

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

Itens: CheckGroupList

Listar todos os locais privados

ID da Operação:: GetV1Privatelocations

Lista todos os locais privados na sua conta.

Devoluções

Itens: privateLocationsListSchema

Listar todos os painéis

ID da Operação:: GetV1Dashboards

Lista todos os painéis atuais na sua conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

Itens: DashboardsList

Listar todos os status de verificação

ID da Operação:: GetV1Checkstatuses

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

Devoluções

Itens: CheckStatusList

Listar todos os trechos

ID da Operação:: GetV1Snippets

Lista todos os trechos atuais na sua conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite o número de resultados.
Número	page		number	O número da página.

Devoluções

Itens: SnippetList

Mostra detalhes para um tempo de execução específico

ID da Operação:: GetV1RuntimesId

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Body: Runtime

Obtenha métricas de integridade de locais privados a partir de uma janela de tempo

ID da Operação:: GetV1PrivatelocationsIdMetrics

Obtenha métricas de integridade de locais privados a partir de uma janela de tempo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
De	from	True	date	Selecione métricas começando com este carimbo de data/hora do UNIX. Deve ser há menos de 15 dias.
Para	to	True	date	Selecione métricas até este carimbo de data/hora UNIX.

Devoluções

Body: privateLocationsMetricsHistoryResponseSchema

Obter o gatilho de verificação

ID da Operação:: GetV1TriggersChecksCheckid

Localiza o gatilho de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Devoluções

Body: CheckTrigger

Obter o gatilho do grupo de verificação

ID da Operação:: GetV1TriggersCheckgroupsGroupid

Localiza o gatilho do grupo de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	groupId	True	integer	O identificador de grupo.

Devoluções

Body: CheckGroupTrigger

Obter selo de status de verificação

ID da Operação:: GetV1BadgesChecksCheckid

Obter selo de status de verificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Estilo	style		string	O estilo.
Theme	theme		string	O tema.
Tempo de resposta	responseTime		boolean	O tempo de resposta.

Devoluções

response: string

Obter selo de status do grupo

ID da Operação:: GetV1BadgesGroupsGroupid

Obtenha o selo de status do grupo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do grupo	groupId	True	integer	O identificador de grupo.
Estilo	style		string	O estilo.
Theme	theme		string	O tema.
Tempo de resposta	responseTime		boolean	O tempo de resposta.

Devoluções

response: string

Recuperar detalhes do status da verificação

ID da Operação:: GetV1CheckstatusesCheckid

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.

Devoluções

Body: CheckStatus

Recuperar todas as verificações em um grupo específico com 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

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

Devoluções

Itens: Model8

Recuperar um canal de alerta

ID da Operação:: GetV1AlertchannelsId

Mostrar detalhes de um canal de alerta específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Devoluções

Body: AlertChannel

Recuperar um check-in em um grupo específico com 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

Name	Chave	Necessário	Tipo	Description
ID do grupo	groupId	True	integer	O identificador de grupo.
Verificar ID	checkId	True	string	O identificador de verificação.

Devoluções

Body: CheckGroupCheck

Recuperar um cheque

ID da Operação:: GetV1ChecksId

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Body: Check

Recuperar um grupo de verificação

ID da Operação:: GetV1CheckgroupsId

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Devoluções

Body: CheckGroup

Recuperar um local privado

ID da Operação:: GetV1PrivatelocationsId

Mostrar detalhes de um local privado específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Body: privatelocationschema

Recuperar um resultado de verificação

ID da Operação:: GetV1CheckresultsCheckidCheckresultid

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Verificar ID	checkId	True	string	O identificador de verificação.
Verificar ID do resultado	checkResultId	True	string	O identificador do resultado da verificação.

Devoluções

Body: CheckResult

Recuperar um trecho

ID da Operação:: GetV1SnippetsId

Mostrar detalhes de um trecho específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Devoluções

Body: Snippet

Recuperar uma janela de manutenção

ID da Operação:: GetV1MaintenancewindowsId

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	integer	O identificador.

Devoluções

Body: 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 chave para seleção.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Key	key	True	string	A chave.

Devoluções

Body: EnvironmentVariable

Remover uma chave de API existente para um local privado

ID da Operação:: DeleteV1PrivatelocationsIdKeysKeyid

Remove permanentemente uma chave api de um local privado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
ID da chave	keyId	True	string	O identificador de chave.

Remover uma localização privada

ID da Operação:: DeleteV1PrivatelocationsId

Remove permanentemente um local privado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Definições

AlertChannelConfig

A configuração do canal de alerta.

Name	Caminho	Tipo	Description
Configuração do canal de alerta		object	A configuração do canal de alerta.

AlertaChanelSubscrição

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

AlertChanelSubscriptionList

Todos os cheques se inscreveram neste canal.

Name	Caminho	Tipo	Description
Itens		AlertChanelSubscription

AlertChannel

Name	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	Todos os cheques se inscreveram neste canal.
Enviar Recuperação	sendRecovery	boolean	Se enviar recuperação.
Falha de envio	sendFailure	boolean	Se falha de envio.
Enviar degradado	sendDegraded	boolean	Se enviar degradado.
Expiração SSL	sslExpiry	boolean	Determina se um alerta deve ser enviado para certificados SSL expirando.
Limite de expiração SSL	sslExpiryThreshold	integer	Em que momento na hora de 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

Name	Caminho	Tipo	Description
Itens		AlertChannel

Alerta de verificação

Name	Caminho	Tipo	Description
ID	id	string	O identificador exclusivo deste alerta.
Nome	name	string	O nome da verificação.
Verificar ID	checkId	string	O identificador de verificação a que este alerta pertence.
Tipo de Alerta	alertType	string	O tipo de alerta.
Tipo de verificação	checkType	string	O tipo de cheque.
Local de execução	runLocation	string	A partir de qual local do data center esse alerta de verificação foi acionado.
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 esta verificação no back-end Checkly não faz parte disso.
Erro	error	string	Quaisquer mensagens de erro específicas que faziam parte da verificação de falha que disparou o alerta.
Código de estado	statusCode	string	O código de status da resposta. Aplica-se apenas a verificações de API.
Criado em	created_at	date	A data e a hora em que este alerta de verificação foi criado.
Começou em	startedAt	date	A data e a hora em que este alerta de verificação foi iniciado.

CheckAlertList

Name	Caminho	Tipo	Description
Itens		CheckAlert

CheckGroupTagList

Tags para organizar e filtrar verificações.

Name	Caminho	Tipo	Description
Itens		string

CheckGroupLocationList

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

Name	Caminho	Tipo	Description
Itens		string

KeyValue

Name	Caminho	Tipo	Description
Key	key	string	A chave.
Valor	value	string	O valor.
Bloqueada	locked	boolean	Se bloqueado.

Lista de cabeçalhos

Name	Caminho	Tipo	Description
Itens		KeyValue

QueryParameterList

Name	Caminho	Tipo	Description
Itens		KeyValue

Asserção

Name	Caminho	Tipo	Description
Fonte	source	string	A fonte.
Propriedade	property	string	A propriedade.
Comparison	comparison	string	A comparação.
Target	target	string	O alvo.

AssertionList

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

Name	Caminho	Tipo	Description
Itens		Assertion

BasicAuth

Name	Caminho	Tipo	Description
Nome de utilizador	username	string	O nome de usuário.
Palavra-passe	password	string	A senha.

CheckGroupAPICheckDefaults

Name	Caminho	Tipo	Description
URL	url	string	A URL base para este 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 asserções	assertions	AssertionList	Verifique a documentação principal de verificação sobre asserçõ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

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

Name	Caminho	Tipo	Description
Verificar padrões de verificação do navegador de grupo		object	O navegador do grupo de verificação verifica os padrões.

EnvironmentVariable

Name	Caminho	Tipo	Description
Key	key	string	A chave da variável de ambiente (este valor não pode ser alterado).
Valor	value	string	O valor da variável de ambiente.
Bloqueada	locked	boolean	Usado somente na interface do usuário para ocultar o valor como uma senha.

EnvironmentVariableList

Name	Caminho	Tipo	Description
Itens		EnvironmentVariable

AlertSettingsRunBasedEscalation

Name	Caminho	Tipo	Description
Limite de Execução com Falha	failedRunThreshold	number	Após quantas verificações consecutivas com falha são executadas, uma notificação de alerta deve ser enviada.

AlertSettingsTimeBasedEscalation

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

AlertaConfiguraçõesLembretes

Name	Caminho	Tipo	Description
Montante	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. Por favor, ignore-o, será removido em uma versão futura.

Name	Caminho	Tipo	Description
Ativado(a)	enabled	boolean	Determina se as notificações de alerta devem ser enviadas para certificados SSL que expiram.
Limiar de alerta	alertThreshold	integer	Em que momento na hora de começar a alertar sobre certificados SSL.

CheckGroupAlertSettings

Configurações de alerta.

Name	Caminho	Tipo	Description
Tipo de escalonamento	escalationType	string	Determina o tipo de escalonamento a ser usado.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Lembretes	reminders	AlertSettingsReminders
Configurações de alerta Certificados SSL	sslCertificates	AlertSettingsSSLCertificates	[PRETERIDO] `sslCertificates` é preterido e não é mais usado. Por favor, ignore-o, será removido em uma versão futura.

Modelo1

Subscrição do canal de alerta.

Name	Caminho	Tipo	Description
ID do canal de alerta	alertChannelId	number	O identificador do canal de alerta.
Ativado	activated	boolean	Se ativado.

AlertChannelSubscriptionCreateList

Lista de subscrições do canal de alerta.

Name	Caminho	Tipo	Description
Subscrição do Canal de Alerta		Model1	Subscrição do canal de alerta.

privateLocalizações

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

Name	Caminho	Tipo	Description
Itens		string

CheckGroup

Name	Caminho	Tipo	Description
ID	id	number	O identificador.
Nome	name	string	O nome do grupo de verificação.
Ativado	activated	boolean	Determina se as verificações no grupo estão em execução ou não.
Mudo	muted	boolean	Determina se alguma notificação será enviada quando um check-in neste grupo falhar e/ou se recuperar.
Verificar Lista de Tags de Grupo	tags	CheckGroupTagList	Tags para organizar e filtrar verificações.
Verificar 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 acionar um grupo de verificação a partir de CI/CD ou por meio da API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Verificar padrões de verificação do navegador de grupo	browserCheckDefaults	CheckGroupBrowserCheckDefaults	O navegador do grupo de verificação verifica os padrões.
environmentVariables	environmentVariables	EnvironmentVariableList
Verificação dupla	doubleCheck	boolean	Definir isso como true acionará uma nova tentativa 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 de nível de 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.
Subscrição do Canal de Alerta Criar Lista	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Lista de subscrições do canal de alerta.
ID do trecho de configuração	setupSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API neste grupo.
ID do trecho de demolição	tearDownSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API neste grupo.
Script de configuração local	localSetupScript	string	Uma parte válida de Node.js código a ser executado na fase de configuração de uma verificação de API neste grupo.
Script de desmontagem local	localTearDownScript	string	Uma parte válida de Node.js código a ser executado na fase de desmontagem de uma verificação de API neste grupo.
ID do tempo de execução	runtimeId	string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usado para executar verificações neste grupo.
Localizações Privadas	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.

Lista de Grupos de Verificação

Name	Caminho	Tipo	Description
Itens		CheckGroup

Lista de Localização Verificada

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

Name	Caminho	Tipo	Description
Itens		string

Lista de Tags de Verificação

Tags para organizar e filtrar verificações.

Name	Caminho	Tipo	Description
Itens		string

CheckAlertSettings

Configurações de alerta.

Name	Caminho	Tipo	Description
Tipo de escalonamento	escalationType	string	Determina o tipo de escalonamento a ser usado.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Lembretes	reminders	AlertSettingsReminders
Configurações de alerta Certificados SSL	sslCertificates	AlertSettingsSSLCertificates	[PRETERIDO] `sslCertificates` é preterido e não é mais usado. Por favor, ignore-o, será removido em uma versão futura.

CheckAlertChannelSubscription

Name	Caminho	Tipo	Description
ID do canal de alerta	alertChannelId	number	O identificador do canal de alerta.
Ativado	activated	boolean	Se ativado.

CheckAlertChannelSubscriptionList

Name	Caminho	Tipo	Description
Itens		CheckAlertChannelSubscription

Verificar Pedido

O pedido de cheque.

Name	Caminho	Tipo	Description
Verificar Pedido		object	O pedido de cheque.

CheckEnvironmentVariableList

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

Name	Caminho	Tipo	Description
Itens		EnvironmentVariable

CheckAlertEmail

Name	Caminho	Tipo	Description
Address	address	string	O endereço.

CheckAlertEmailList

Name	Caminho	Tipo	Description
Itens		CheckAlertEmail

Modelo4

Name	Caminho	Tipo	Description
Itens		KeyValue

Modelo5

Name	Caminho	Tipo	Description
Itens		KeyValue

CheckAlertWebhook

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

CheckAlertWebhookList

Name	Caminho	Tipo	Description
Itens		CheckAlertWebhook

CheckAlertSlack

Name	Caminho	Tipo	Description
URL	url	string	O endereço URL.

CheckAlertSlackList

Name	Caminho	Tipo	Description
Itens		CheckAlertSlack

CheckAlertSMS

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

CheckAlertSMSList

Name	Caminho	Tipo	Description
Itens		CheckAlertSMS

CheckAlertChannels

Name	Caminho	Tipo
e-mail	email	CheckAlertEmailList
webhook	webhook	CheckAlertWebhookList
folga	slack	CheckAlertSlackList
mensagem de texto (SMS)	sms	CheckAlertSMSList

CheckGroupCheck

Name	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Ativado	activated	boolean	Determina se a verificação está em execução ou não.
Mudo	muted	boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck	boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags	CheckTagList	Tags 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 de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId	string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo de cheque.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset	integer	A compensação de frequência.
Verificar Pedido	request	CheckRequest	O pedido de cheque.
Script	script	string	O roteiro.
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. Estes são relevantes apenas para verificações do navegador. Use variáveis de ambiente global sempre que possível.
ID do trecho de configuração	setupSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
ID do trecho de demolição	tearDownSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
Script de configuração local	localSetupScript	string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript	string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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
Localizações Privadas	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.

Modelo8

Name	Caminho	Tipo	Description
Itens		CheckGroupCheck

asserções

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

Name	Caminho	Tipo	Description
Itens		string

headers

Os cabeçalhos.

Name	Caminho	Tipo	Description
Headers		object	Os cabeçalhos.

parâmetros

Os parâmetros.

Name	Caminho	Tipo	Description
Params		object	Os parâmetros.

pedido

A solicitação para a API.

Name	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 timings.

Name	Caminho	Tipo	Description
Horários		object	Os timings.

tempoFases

As fases de cronometragem.

Name	Caminho	Tipo	Description
Fases de cronometragem		object	As fases de cronometragem.

response

A resposta da API.

Name	Caminho	Tipo	Description
Situação	status	number	O status.
Texto de status	statusText	string	O texto do status.
Body	body	string	O corpo.
Headers	headers	headers	Os cabeçalhos.
Horários	timings	timings	Os timings.
Fases de cronometragem	timingPhases	timingPhases	As fases de cronometragem.

jobLog

O log de trabalhos.

Name	Caminho	Tipo	Description
Registo de Trabalhos		object	O log de trabalhos.

jobAssets

Ativos gerados a partir da execução do cheque.

Name	Caminho	Tipo	Description
Itens		string

CheckResultAPI

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

Name	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.
Registo de Trabalhos	jobLog	jobLog	O log de trabalhos.
Ativos de trabalho	jobAssets	jobAssets	Ativos gerados a partir da execução do cheque.

erros

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

Name	Caminho	Tipo	Description
Itens		string

Modelo9

Verifique os resultados do log de execução.

Name	Caminho	Tipo	Description
Itens		string

traceSummary

O resumo do rastreamento.

Name	Caminho	Tipo	Description
Resumo do rastreio		object	O resumo do rastreamento.

pages

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

Name	Caminho	Tipo	Description
Itens		string

CheckResultBrowser

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

Name	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 da 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 de tempo de execução	runtimeVersion	string	Versão ativa do tempo de execução.
Verifique o 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 do cheque.
Resumo do rastreio	traceSummary	traceSummary	O resumo do rastreamento.
Páginas	pages	pages	Lista de páginas usadas na execução de verificação.

VerificarResultado

Name	Caminho	Tipo	Description
ID	id	string	O identificador exclusivo deste 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 esta execução de verificação. Este deve ser o seu 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 seja verdadeiro.
Tem erros	hasErrors	boolean	Descreve se ocorreu um erro interno no back-end do 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 degradedResponseTime na verificação. Aplica-se apenas a verificações de API.
Tempo de resposta superior ao máximo	overMaxResponseTime	boolean	Defina como true se o tempo de resposta estiver acima do limite definido pelo campo maxResponseTime na verificação. Aplica-se apenas a verificações de API.
Local de execução	runLocation	string	De qual local de data center esse resultado de verificação se originou.
Começou em	startedAt	date-time	O começou na hora.
Parou em	stoppedAt	date-time	O parou na hora.
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 esta verificação no back-end Checkly não faz parte disso.
Verificar API de resultados	apiCheckResult	CheckResultAPI	Os dados de resposta para uma verificação de API.
Resultado da verificação do navegador	browserCheckResult	CheckResultBrowser	Os dados de resposta para uma verificação do navegador.
Verifique o ID de 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 ativada.

CheckResultList

Name	Caminho	Tipo	Description
Itens		CheckResult

Verificar Status

Name	Caminho	Tipo	Description
Nome	name	string	O nome da verificação.
Verificar ID	checkId	string	O identificador de verificação deste status pertence.
Tem falhas	hasFailures	boolean	Descreve se essa verificação está falhando no momento. Se qualquer uma das asserções para uma verificação de API falhar, esse valor será true. Se uma verificação do navegador falhar por qualquer motivo, isso é verdade.
Tem erros	hasErrors	boolean	Descreve se, devido a algum erro fora da operação normal, essa verificação está falhando. Isso deve ser extremamente raro e somente quando há 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 degradedResponseTime na verificação. Aplica-se apenas a verificações de API.
Corrida mais longa	longestRun	number	O maior tempo de resposta alguma vez registado para esta verificação.
Corrida mais curta	shortestRun	number	O menor tempo de resposta alguma vez registado para esta verificação.
Local da última execução	lastRunLocation	string	Em que local esta verificação foi executada pela última vez.
Última verificação ID de execução	lastCheckRunId	string	O identificador de incremento exclusivo para cada execução de verificação.
SSL Dias Restantes	sslDaysRemaining	number	Quantos dias faltam para o certificado SSL atual expirar.
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckStatusList

Name	Caminho	Tipo	Description
Itens		CheckStatus

Verificar

Name	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Ativado	activated	boolean	Determina se a verificação está em execução ou não.
Mudo	muted	boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck	boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags	CheckTagList	Tags 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 de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId	string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo de cheque.
Frequência	frequency	integer	Com que frequência a verificação deve ser executada em minutos.
Deslocamento de frequência	frequencyOffset	integer	A compensação de frequência.
Verificar Pedido	request	CheckRequest	O pedido de cheque.
Script	script	string	O roteiro.
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. Estes são relevantes apenas para verificações do navegador. Use variáveis de ambiente global sempre que possível.
ID do trecho de configuração	setupSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
ID do trecho de demolição	tearDownSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
Script de configuração local	localSetupScript	string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript	string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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
Localizações Privadas	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.

Lista de verificação

Name	Caminho	Tipo	Description
Itens		Check

Modelo14

Name	Caminho	Tipo	Description
Itens		KeyValue

Modelo15

Name	Caminho	Tipo	Description
Itens		KeyValue

Modelo16

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

Name	Caminho	Tipo	Description
método	method	string
URL	url	string	O endereço URL.
Seguir redirecionamentos	followRedirects	boolean	Se os redirecionamentos devem ser seguidos.
Ignorar SSL	skipSSL	boolean	Se deve ignorar SSL.
Body	body	string	O corpo.
Tipo de Corpo	bodyType	string	O tipo de corpo.
headers	headers	Model14
queryParameters	queryParameters	Model15
Lista de asserções	assertions	AssertionList	Verifique a documentação principal de verificação sobre asserçõ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

Name	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Ativado	activated	boolean	Determina se a verificação está em execução ou não.
Mudo	muted	boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck	boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags	CheckTagList	Tags 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 de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId	string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Verificar Pedido	request	Model16	Determina a solicitação 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 frequências de verificação inferiores a 1 minuto (apenas para verificações API) e espalhar verificações ao longo de um intervalo de tempo para frequências superiores a 1 minuto. Isso funciona da seguinte forma: Verificações com uma frequência de 0 podem ter uma frequênciaOffset de 10, 20 ou 30, o que significa que serão executadas a cada 10, 20 ou 30 segundos. Verificações com uma frequência menor e igual a 60 podem ter um frequencyOffset entre 1 e um valor máximo com base na fórmula Math.floor(frequência * 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 superior a 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 trecho de demolição	tearDownSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de desmontagem de uma verificação de API.
ID do trecho de configuração	setupSnippetId	number	Uma referência de identificador a um trecho a ser usado na fase de configuração de uma verificação de API.
Script de configuração local	localSetupScript	string	Uma parte válida de Node.js código para ser executado na fase de configuração.
Script de desmontagem local	localTearDownScript	string	Uma parte válida de Node.js código para ser executado na fase de desmontagem.
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.
Localizações Privadas	privateLocations	privateLocations	Uma matriz de um ou mais locais privados onde executar a verificação.
Tipo de verificação	checkType	string	O tipo de cheque.
alertChannels	alertChannels	CheckAlertChannels
Criado em	created_at	date	Quando criado em.
Atualizado em	updated_at	date-time	Quando atualizado em.

CheckBrowser

Name	Caminho	Tipo	Description
ID	id	string	O identificador.
Nome	name	string	O nome da verificação.
Ativado	activated	boolean	Determina se a verificação está em execução ou não.
Mudo	muted	boolean	Determina se alguma notificação será enviada quando uma verificação falhar e/ou for recuperada.
Verificação dupla	doubleCheck	boolean	Definir isso como true acionará uma nova tentativa quando uma verificação falhar na região com falha e outra região selecionada aleatoriamente antes de marcar a verificação como falha.
Em caso de reprovação	shouldFail	boolean	Permite inverter o comportamento de quando uma verificação é considerada falha. Permite validar o status de 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 tags	tags	CheckTagList	Tags 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 de nível de 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 esta verificação faz parte.
Ordem de Grupo	groupOrder	number	A posição desta verificação em um grupo de verificação. Ele determina em que ordem as verificações são executadas quando um grupo é acionado a partir da API ou do CI/CD.
ID do tempo de execução	runtimeId	string	A versão de tempo de execução, ou seja, conjunto fixo de dependências de tempo de execução, usada para executar essa verificação.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Tipo de verificação	checkType	string	O tipo de cheque.
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.
Localizações Privadas	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 tags que filtram as verificações para exibição no painel.

Name	Caminho	Tipo	Description
Itens		string

Dashboard

Name	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 seu uso de DNS e SSL.
URL personalizado	customUrl	string	Um nome de subdomínio em checklyhq.com. Precisa ser único em todos os usuários.
Logótipo	logo	string	Um URL apontando para um arquivo de imagem.
ícone de favorito	favicon	string	Um URL apontando para um arquivo de imagem usado como dashboard favicon.
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 pedaço de texto exibido abaixo do cabeçalho ou título do seu painel.
Largura	width	string	Determina se a tela inteira deve ser usada ou o foco no centro.
Taxa de atualização	refreshRate	number	Com que frequência atualizar o painel em segundos.
Paginato	paginate	boolean	Determina se a paginação está ativada ou desativada.
Taxa de paginação	paginationRate	number	Com que frequência acionar a paginação em segundos.
Verificações por Página	checksPerPage	number	Número de cheques exibidos por página.
Uso E Operador	useTagsAndOperator	boolean	Quando usar o operador AND para pesquisa de tags.
Ocultar tags	hideTags	boolean	Mostrar ou ocultar as tags no painel.
Lista de tags do painel	tags	DashboardTagList	Uma lista de uma ou mais tags que filtram as verificações para exibição no painel.
ID do painel	dashboardId	string	O identificador do painel.

Lista de Painéis

Name	Caminho	Tipo	Description
Itens		Dashboard

Localização

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

Lista de localizações

Name	Caminho	Tipo	Description
Itens		Location

MaintenanceWindowTagList

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

Name	Caminho	Tipo	Description
Itens		string

Janela de Manutenção

Name	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 tags da janela de manutenção	tags	MaintenanceWindowTagList	Os nomes da janela de manutenção de verificações e grupos devem ser aplicados.
Começa em	startsAt	date	A data de início da janela de manutenção.
Termina em	endsAt	date	A data final da janela de manutenção.
Intervalo de repetição	repeatInterval	number	O intervalo de repetição da janela de manutenção a partir da primeira ocorrência.
Unidade de repetição	repeatUnit	string	A estratégia de repetição para a janela de manutenção.
Repetir termina em	repeatEndsAt	date	A data final em que a janela de manutenção deve parar de se 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.

Name	Caminho	Tipo	Description
Itens		MaintenanceWindow

CheckAssignment

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

checkAtribuições

A verificação que este local privado atribuiu.

Name	Caminho	Tipo	Description
Itens		CheckAssignment

Atribuição de Grupo

Name	Caminho	Tipo	Description
ID	id	guid	O identificador.
ID do grupo	groupId	number	O identificador do grupo.
ID de Localização Privada	privateLocationId	guid	O identificador do local privado atribuído.

groupAssignments

O grupo que este local privado atribuiu.

Name	Caminho	Tipo	Description
Itens		GroupAssignment

privateLocationKeys

Name	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.

Teclas

Name	Caminho	Tipo	Description
Itens		privateLocationKeys

privatelocationschema

Name	Caminho	Tipo	Description
ID	id	guid	O identificador.
Nome	name	string	O nome atribuído ao local privado.
Nome da lesma	slugName	string	Nome da lesma válido.
Ícone	icon	string	O ícone de localização privada.
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.
Trabalhos de Grupo	groupAssignments	groupAssignments	O grupo que este local privado atribuiu.
Teclas	keys	keys
Visto pela última vez	lastSeen	date	A última data vista.
Contagem de agentes	agentCount	number	O agente conta.

privateLocationsListSchema

Name	Caminho	Tipo	Description
Itens		privatelocationschema

commonPrivateLocationSchemaResponse

Name	Caminho	Tipo	Description
ID	id	guid	O identificador.
Nome	name	string	O nome atribuído ao local privado.
Nome da lesma	slugName	string	Nome da lesma válido.
Ícone	icon	string	O ícone de localização privada.
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.
Trabalhos de Grupo	groupAssignments	groupAssignments	O grupo que este local privado atribuiu.
Teclas	keys	keys

carimbos de data/hora

Name	Caminho	Tipo	Description
Data e Hora		date-time	O carimbo de data/hora.

queueSize

O tamanho da fila.

Name	Caminho	Tipo	Description
Itens		number

oldestScheduledCheckRun

Name	Caminho	Tipo	Description
Itens		number

privateLocationsMetricsHistoryResponseSchema

Name	Caminho	Tipo	Description
carimbos de data/hora	timestamps	timestamps
Tamanho da fila	queueSize	queueSize	O tamanho da fila.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Verifique as tags.

Name	Caminho	Tipo	Description
Itens		string

RelatóriosAgregados

Name	Caminho	Tipo	Description
Rácio de Sucesso	successRatio	number	Taxa de sucesso do intervalo de datas de verificação selecionado. A percentagem está na forma decimal.
Average	avg	number	Tempo médio de resposta da verificação sobre o intervalo de datas selecionado em milissegundos.
Pág. 95	p95	number	Tempo de resposta P95 da verificação sobre o intervalo de datas selecionado em milissegundos.
Pág. 99	p99	number	Tempo de resposta P99 da verificação sobre o intervalo de datas selecionado em milissegundos.

Elaboração de Relatórios

Name	Caminho	Tipo	Description
Nome	name	string	Verifique o nome.
Verificar ID	checkId	string	Verifique o ID.
Tipo de verificação	checkType	string	Verifique o tipo.
Desativada	deactivated	boolean	Verifique desativado.
Lista de tags de relatórios	tags	ReportingTagList	Verifique as tags.
agregação	aggregate	ReportingAggregate

Lista de relatórios

Name	Caminho	Tipo	Description
Itens		Reporting

Tempo de execução

Name	Caminho	Tipo	Description
Nome	name	string	O nome exclusivo deste tempo de execução.
Fase	stage	string	Estágio de vida atual de um tempo de execução.
Fim da vida útil do tempo de execução	runtimeEndOfLife	string	Data em que um tempo de execução será removido da nossa plataforma.
Default	default	boolean	Indica se este é o tempo de execução padrão atual fornecido pelo Checkly.
Description	description	string	Uma breve descrição legível por humanos das principais atualizações neste tempo de execução.
Cordão	dependencies.string	string	A cadeia de caracteres.

Lista de tempo de execução

Name	Caminho	Tipo	Description
Itens		Runtime

Trechos

Name	Caminho	Tipo	Description
ID	id	number	O identificador.
Nome	name	string	O nome do trecho.
Script	script	string	Seu código Node.js que interage com o ciclo de vida de verificação da API ou funciona como uma 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

Name	Caminho	Tipo	Description
Itens		Snippet

CheckGroupTrigger

Name	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 para.
Atualizado em	updated_at	date	Quando atualizado em.
ID do grupo	groupId	number	O identificador de grupo.

CheckTrigger

Name	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 para.
Atualizado em	updated_at	date	Quando atualizado em.
Verificar ID	checkId	string	O identificador de verificação.

objecto

Este é o tipo 'objeto'.

cadeia (de caracteres)

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

Partilhar via

Checkly (Editora Independente) (Pré-visualização)

A criar uma ligação

Padrão

Limites de Limitação

Ações

Atualizar as subscrições de um canal de alerta

Parâmetros

Devoluções

Atualizar um canal de alerta

Parâmetros

Devoluções

Atualizar um grupo de verificação

Parâmetros

Devoluções

Atualizar um painel

Parâmetros

Devoluções

Atualizar um trecho

Parâmetros

Devoluções

Atualizar uma janela de manutenção

Parâmetros

Devoluções

Atualizar uma localização privada

Parâmetros

Devoluções

Atualizar uma variável de ambiente

Parâmetros

Devoluções

Atualizar uma verificação [DEPRECATED]

Parâmetros

Devoluções

Atualizar uma verificação de API

Parâmetros

Devoluções

Atualizar uma verificação do navegador

Parâmetros

Devoluções

Criar o gatilho de verificação

Parâmetros

Devoluções

Criar o gatilho do grupo de verificação

Parâmetros

Devoluções

Criar um canal de alerta

Parâmetros

Devoluções

Criar um dashboard

Parâmetros

Devoluções

Criar um grupo de verificação

Parâmetros

Devoluções

Criar um snippet

Parâmetros

Devoluções

Criar uma janela de manutenção

Parâmetros

Devoluções

Criar uma localização privada

Parâmetros

Devoluções

Criar uma variável de ambiente

Parâmetros

Devoluções

Criar uma verificação [DEPRECATED]

Parâmetros

Devoluções

Criar uma verificação de API

Parâmetros

Devoluções

Criar uma verificação do navegador

Parâmetros

Devoluções

Eliminar um dashboard

Parâmetros

Excluir o gatilho de verificação

Parâmetros

Excluir o gatilho do grupo de verificação