Monitores

Notas
Nível avançado
A chave API deve ser enviada como token Bearer no cabeçalho Authorization. Obtenha sua chave API.
Listar

Endpoint da API:

GET 
https://radarvis.com.br/public/api/v1/monitors

Exemplo de requisição: 

curl --location --request GET 'https://radarvis.com.br/public/api/v1/monitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
A consulta de pesquisa.
search_by
opcional string
Pesquisar por. Os valores possíveis são: name para Nome, url para URL. Padrão: name.
status_page_id
opcional integer
ID da página de status.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, name para Nome, url para URL. Padrão: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Descendente, asc para Ascendente. Padrão: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Padrão: 25.
Mostrar

Endpoint da API:

GET 
https://radarvis.com.br/public/api/v1/monitors/{id}

Exemplo de requisição: 

curl --location --request GET 'https://radarvis.com.br/public/api/v1/monitors/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Criar

Endpoint da API:

POST 
https://radarvis.com.br/public/api/v1/monitors

Exemplo de requisição: 

curl --location --request POST 'https://radarvis.com.br/public/api/v1/monitors' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'url={url}'
Parâmetro
Tipo
Descrição
name
obrigatório string
Nome.
url
obrigatório string
URL.
interval
obrigatório integer
Intervalo. Os valores possíveis são: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
obrigatório string
Condição de alerta. Os valores possíveis são: url_unavailable para URL fica indisponível, url_text para A resposta da URL contém texto, url_no_text para A resposta da URL não contém texto.
alert_text_lookup
opcional string
Texto a ser procurado para acionar alertas. Funciona apenas quando o campo alert_condition está definido como url_text, url_no_text.
request_method
obrigatório string
Método da requisição. Os valores possíveis são: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
opcional string
Nome do cabeçalho da requisição.
request_headers[index][value]
opcional string
Valor do cabeçalho da requisição.
request_auth_username
opcional string
Username for Basic HTTP request authentication.
request_auth_password
opcional string
Password for Basic HTTP request authentication.
cache_buster
opcional integer
Cache buster. Os valores possíveis são: 0 para Desativado, 1 para Ativado. Padrão: 0.
ssl_alert_days
opcional integer
O número de dias antes da expiração do certificado SSL para receber um alerta. Os valores possíveis são: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
Número de dias antes da expiração do domínio para receber um alerta. Os valores possíveis são: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Data de início da manutenção no formato Y-m-d H:i.
maintenance_end_at
opcional string
Data de término da manutenção no formato Y-m-d H:i.
alerts[index][key]
opcional string
Canais de alerta. Os valores possíveis são: email para Email, webhook para Webhook, slack para Slack, teams para Microsoft Teams, discord para Discord, flock para Flock, sms para SMS.
alerts[index][value]
opcional string
Valor do alerta.
Atualizar

Endpoint da API:

PUT PATCH 
https://radarvis.com.br/public/api/v1/monitors/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://radarvis.com.br/public/api/v1/monitors/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parâmetro
Tipo
Descrição
name
opcional string
Nome.
url
opcional string
URL.
interval
opcional integer
Intervalo. Os valores possíveis são: 60, 180, 300, 600, 900, 1800, 3600.
alert_condition
opcional string
Condição de alerta. Os valores possíveis são: url_unavailable para URL fica indisponível, url_text para A resposta da URL contém texto, url_no_text para A resposta da URL não contém texto.
alert_text_lookup
opcional string
Texto a ser procurado para acionar alertas. Funciona apenas quando o campo alert_condition está definido como url_text, url_no_text.
request_method
opcional string
Método da requisição. Os valores possíveis são: GET, POST, HEAD, PUT, DELETE, PATCH, OPTIONS.
request_headers[index][key]
opcional string
Nome do cabeçalho da requisição.
request_headers[index][value]
opcional string
Valor do cabeçalho da requisição.
request_auth_username
opcional string
Username for Basic HTTP request authentication.
request_auth_password
opcional string
Password for Basic HTTP request authentication.
cache_buster
opcional integer
Cache buster. Os valores possíveis são: 0 para Desativado, 1 para Ativado.
ssl_alert_days
opcional integer
O número de dias antes da expiração do certificado SSL para receber um alerta. Os valores possíveis são: 0, 1, 2, 3, 7, 14, 30, 60.
domain_alert_days
opcional integer
Número de dias antes da expiração do domínio para receber um alerta. Os valores possíveis são: 0, 1, 2, 3, 7, 14, 30, 60.
maintenance_start_at
opcional string
Data de início da manutenção no formato Y-m-d H:i.
maintenance_end_at
opcional string
Data de término da manutenção no formato Y-m-d H:i.
alerts[index][key]
opcional string
Canais de alerta. Os valores possíveis são: email para Email, webhook para Webhook, slack para Slack, teams para Microsoft Teams, discord para Discord, flock para Flock, sms para SMS.
alerts[index][value]
opcional string
Valor do alerta.
paused
opcional boolean
Pausado.
Excluir

Endpoint da API:

DELETE 
https://radarvis.com.br/public/api/v1/monitors/{id}

Exemplo de requisição: 

curl --location --request DELETE 'https://radarvis.com.br/public/api/v1/monitors/{id}' \
--header 'Authorization: Bearer {api_key}'