Checkly (Publicador independiente) (versión preliminar)

Checkly es la plataforma de supervisión para la pila moderna: programable, flexible y amable JavaScript. Supervise y valide las transacciones de sitio cruciales. Recopile automáticamente seguimientos de errores, capturas de pantalla y métricas de rendimiento con cada comprobación que ejecute.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Troy Taylor
URL	https://www.hitachisolutions.com
Correo Electrónico	ttaylor@hitachisolutions.com

Metadatos del conector
Publicador	Troy Taylor
Sitio web	https://www.checklyhq.com/
Directiva de privacidad	https://www.checklyhq.com/privacy
Categorías	Operaciones de TI

Creación de una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
Id. de cuenta	securestring	Identificador de cuenta de esta API.	Cierto
Clave de API (con el formato "Bearer apiKey")	securestring	La clave de API (con el formato "Bearer apiKey") para esta API	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualización de las suscripciones de un canal de alerta	Actualice las suscripciones de un canal de alertas. Úselo para agregar una comprobación a un canal de alerta para que las alertas de error y recuperación se envíen para esa comprobación. Nota: al pasar el objeto de suscripción, solo puede especificar un checkId o un groupId, no ambos.
Actualización de un canal de alerta	Actualice un canal de alerta.
Actualización de un panel	Actualiza un panel. Devolverá un 409 al intentar crear un panel con una dirección URL personalizada o un dominio personalizado que ya se haya tomado.
Actualización de una comprobación de API	Actualiza una comprobación de API.
Actualización de una comprobación del explorador	Actualiza una comprobación del explorador.
Actualización de una ubicación privada	Actualiza una ubicación privada.
Actualización de una variable de entorno	Actualiza una variable de entorno. Usa el campo de clave como identificador para la actualización. Solo actualiza el valor y la propiedad bloqueada.
Actualizar un fragmento de código	Actualiza un fragmento de código.
Actualizar un grupo de comprobación	Actualiza un grupo de comprobación.
Actualizar una comprobación [EN DESUSO]	[EN DESUSO] Este punto de conexión se quitará el lunes 4 de julio de 2022. En su lugar, use `PUT /checks/api/{id}` o `PUT /checks/browser/{id}`. Actualiza una nueva comprobación de API o explorador.
Actualizar una ventana de mantenimiento	Actualiza una ventana de mantenimiento.
Creación de un canal de alerta	Crea un nuevo canal de alertas.
Creación de un fragmento de código	Crea un nuevo fragmento de código.
Creación de un grupo de comprobación	Crea un nuevo grupo de comprobación. Puede agregar comprobaciones al grupo estableciendo la propiedad groupId de comprobaciones individuales.
Creación de una comprobación de API	Crea una nueva comprobación de API. Devolverá un cuando `402` supere el límite del plan. Al usar `globalAlertSetting`, puede ser .`alertSettingnull`
Creación de una comprobación del explorador	Crea una nueva comprobación del explorador. Devolverá un cuando `402` supere el límite del plan. Al usar `globalAlertSetting`, puede ser .`alertSettingnull`
Creación de una ubicación privada	Crea una nueva ubicación privada.
Creación de una variable de entorno	Crea una nueva variable de entorno.
Creación de una ventana de mantenimiento	Crea una nueva ventana de mantenimiento.
Creación del desencadenador check	Crea el desencadenador check.
Creación del desencadenador de grupo de comprobación	Crea el desencadenador check group.
Crear un tablero de control	Crea un nuevo panel. Devolverá un 409 al intentar crear un panel con una dirección URL personalizada o un dominio personalizado que ya se haya tomado.
Crear una comprobación [EN DESUSO]	[EN DESUSO] Este punto de conexión se quitará el lunes 4 de julio de 2022. En su lugar, use `POST /checks/api` o `POST /checks/browser`. Crea una nueva comprobación de API o explorador. Devolverá un cuando `402` supere el límite del plan. Al usar `globalAlertSettings`, puede ser .`alertSettingsnull`
Eliminación de un canal de alerta	Quita permanentemente un canal de alerta.
Eliminación de una clave de API existente para una ubicación privada	Quita permanentemente una clave de API de una ubicación privada.
Eliminación de una variable de entorno	Quita permanentemente una variable de entorno. Usa el campo de clave como identificador para su eliminación.
Eliminación del desencadenador check	Elimina el desencadenador check.
Eliminación del desencadenador de grupo de comprobación	Elimina el desencadenador de grupos de comprobación.
Eliminar un fragmento de código	Quita permanentemente un fragmento de código.
Eliminar un grupo de comprobación	Quita permanentemente un grupo de comprobación. No se puede eliminar un grupo de comprobación si todavía contiene comprobaciones.
Eliminar un panel	Quita permanentemente un panel.
Eliminar una comprobación	Quita permanentemente una comprobación de API o explorador y todos sus datos de estado y resultados relacionados.
Eliminar una ventana de mantenimiento	Quita permanentemente una ventana de mantenimiento.
Enumera todas las ubicaciones admitidas	Enumera todas las ubicaciones admitidas.
Enumera todos los entornos de ejecución admitidos	Enumera todos los entornos de ejecución admitidos y los paquetes de NPM incluidos para comprobaciones del explorador y scripts de configuración y desmontaje para comprobaciones de API.
Enumera todos los resultados de la comprobación	Enumera los resultados completos y sin procesar de una comprobación específica. Mantenemos los resultados sin procesar durante 30 días. Después de 30 días se borran. Sin embargo, mantenemos los resultados inscritos durante un período indefinido. Puede filtrar por tipo de comprobación y tipo de resultado para restringir la lista. Use los `to` parámetros y `from` para especificar un intervalo de fechas (marca de tiempo de UNIX en segundos). En función del tipo de comprobación, algunos campos pueden ser NULL. Este punto de conexión devolverá datos en un período de seis horas. Si se establecen los parámetros de y a , deben estar al máximo de seis horas de diferencia. Si no se establece ninguno, consideraremos el parámetro para que sea ahora y de param a ser seis horas antes. Si solo se establece el parámetro param, se establecerá de a seis horas antes. Por el contrario, si solo se establece el parámetro from, consideraremos que param será seis horas más tarde. La limitación de velocidad se aplica a este punto de conexión, puede enviar 5 solicitudes o 10 segundos como máximo.
Enumeración de todos los canales de alerta	Enumera todos los canales de alerta configurados y sus comprobaciones suscritas.
Enumerar alertas para una comprobación específica	Enumera todas las alertas de una comprobación específica.
Enumerar todas las alertas de la cuenta	Enumera todas las alertas de la cuenta.
Enumerar todas las comprobaciones	Enumera todas las comprobaciones actuales de la cuenta.
Enumerar todas las ubicaciones privadas	Enumera todas las ubicaciones privadas de la cuenta.
Enumerar todas las variables de entorno	Enumera todas las variables de entorno actuales de la cuenta.
Enumerar todas las ventanas de mantenimiento	Enumera todas las ventanas de mantenimiento de su cuenta.
Enumerar todos los estados de comprobación	Muestra la información de estado actual de todas las comprobaciones de la cuenta. Los registros de estado de comprobación se actualizan continuamente a medida que se producen nuevos resultados de comprobación.
Enumerar todos los fragmentos de código	Enumera todos los fragmentos de código actuales de la cuenta.
Enumerar todos los grupos de comprobación	Enumera todos los grupos de comprobación actuales de la cuenta. La propiedad checks es una matriz de comprobación del UUID para hacer referencia conveniente. Es de solo lectura y no se puede usar para agregar comprobaciones a un grupo.
Enumerar todos los paneles	Enumera todos los paneles actuales de la cuenta.
Genera un informe con estadísticas agregadas para comprobaciones y grupos de comprobación	Genera un informe con estadísticas agregadas para todas las comprobaciones o un conjunto filtrado de comprobaciones a través de un período de tiempo especificado.
Genera un informe personalizable para todas las métricas de Comprobación del explorador.	Genera un informe con estadísticas agregadas o no agregadas para una comprobación de explorador específica en un período de tiempo especificado.
Generación de una nueva clave de API para una ubicación privada	Crea una clave de API en la ubicación privada.
Muestra los detalles de un entorno de ejecución específico.	Muestra los detalles de todos los paquetes de NPM incluidos y su versión para un entorno de ejecución específico.
Obtención de métricas de estado de ubicación privada desde un período de tiempo	Obtenga métricas de estado de ubicación privada desde un período de tiempo.
Obtención del desencadenador check	Busca el desencadenador check.
Obtención del desencadenador del grupo de comprobación	Busca el desencadenador de grupo check.
Obtención del distintivo de estado de comprobación	Obtener la notificación de estado de comprobación.
Obtención del distintivo de estado del grupo	Obtener el distintivo de estado del grupo.
Quitar una ubicación privada	Quita permanentemente una ubicación privada.
Recuperación de los detalles del estado de comprobación	Muestra la información de estado actual de una comprobación específica.
Recuperación de un canal de alerta	Mostrar detalles de un canal de alerta específico.
Recuperación de un fragmento de código	Mostrar detalles de un fragmento de código específico.
Recuperación de un grupo de comprobación	Mostrar detalles de un grupo de comprobación específico.
Recuperación de un resultado de comprobación	Mostrar detalles de un resultado de comprobación específico.
Recuperación de una comprobación en un grupo específico con la configuración de grupo aplicada	Muestra los detalles de una comprobación en un grupo de comprobación específico con la configuración de grupo aplicada.
Recuperación de una ubicación privada	Mostrar detalles de una ubicación privada específica.
Recuperación de una variable de entorno	Mostrar detalles de una variable de entorno específica. Usa el campo de clave para la selección.
Recuperar todas las comprobaciones de un grupo específico con la configuración de grupo aplicada	Enumera todas las comprobaciones de un grupo de comprobación específico con la configuración de grupo aplicada.
Recuperar una comprobación	Muestra los detalles de una comprobación específica de la API o del explorador.
Recuperar una ventana de mantenimiento	Mostrar detalles de una ventana de mantenimiento específica.

Actualización de las suscripciones de un canal de alerta

Id. de la operación:: PutV1AlertchannelsIdSubscriptions

Actualice las suscripciones de un canal de alertas. Úselo para agregar una comprobación a un canal de alerta para que las alertas de error y recuperación se envíen para esa comprobación. Nota: al pasar el objeto de suscripción, solo puede especificar un checkId o un groupId, no ambos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
Comprobar id.	checkId		guid	Puede pasar un checkId o un groupId, pero no ambos.
Identificador de grupo	groupId		number	Puede pasar un checkId o un groupId, pero no ambos.
Activated	activated	True	boolean	Si se activa.

Devoluciones

Body: AlertChanelSubscription

Actualización de un canal de alerta

Id. de la operación:: PutV1AlertchannelsId

Actualice un canal de alerta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
identificación	id		number	Identificador.
Comprobar id.	checkId		guid	Identificador de comprobación.
Identificador de grupo	groupId		number	Identificador de grupo.
Activated	activated	True	boolean	Si se activa.
Tipo	type	True	string	Tipo.
Configuración de creación del canal de alertas	config	True	object	El canal de alerta crea la configuración.
Enviar recuperación	sendRecovery		boolean	Indica si se envía la recuperación.
Error de envío	sendFailure		boolean	Indica si se ha enviado un error.
Enviar degradado	sendDegraded		boolean	Indica si se ha degradado el envío.
Expiración de SSL	sslExpiry		boolean	Determina si se debe enviar una alerta para que expiren los certificados SSL.
Umbral de expiración de SSL	sslExpiryThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.

Devoluciones

Body: AlertChannel

Actualización de un panel

Id. de la operación:: PutV1DashboardsDashboardid

Actualiza un panel. Devolverá un 409 al intentar crear un panel con una dirección URL personalizada o un dominio personalizado que ya se haya tomado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	dashboardId	True	string	Identificador del panel.
Dirección URL personalizada	customUrl		string	Nombre de subdominio en checklyhq.com. Debe ser único en todos los usuarios.
Dominio personalizado	customDomain		string	Un dominio de usuario personalizado, por ejemplo, status.example.com. Consulte los documentos sobre cómo actualizar el uso de DNS y SSL.
Logotipo	logo		string	Dirección URL que apunta a un archivo de imagen.
Icono de favoritos	favicon		string	Dirección URL que apunta a un archivo de imagen usado como favicon del panel.
Link	link		string	Vínculo de dirección URL para redirigir cuando se hace clic en el logotipo del panel.
Header	header		string	Fragmento de texto que se muestra en la parte superior del panel.
Description	description		string	Fragmento de texto que se muestra debajo del encabezado o título del panel.
Ancho	width		string	Determina si se va a usar la pantalla completa o el foco en el centro.
Frecuencia de actualización	refreshRate		number	Frecuencia con la que se actualiza el panel en segundos.
Paginar	paginate		boolean	Determina si la paginación está activada o desactivada.
Tasa de paginación	paginationRate		number	Frecuencia con la que se desencadena la paginación en segundos.
Comprobaciones por página	checksPerPage		number	Número de comprobaciones mostradas por página.
Use y (operador)	useTagsAndOperator		boolean	Cuándo usar el operador AND para la búsqueda de etiquetas.
Ocultar etiquetas	hideTags		boolean	Mostrar u ocultar las etiquetas en el panel.
Lista de etiquetas del panel	tags		array of string	Lista de una o varias etiquetas que filtran qué comprobaciones se muestran en el panel.

Devoluciones

Body: Dashboard

Actualización de una comprobación de API

Id. de la operación:: PutV1ChecksApiId

Actualiza una comprobación de API.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name		string	Nombre de la comprobación.
Activated	activated		boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
method	method	True	string
URL	url	True	string	Dirección URL.
Seguir redireccionamientos	followRedirects		boolean	Indica si se deben seguir las redirecciones.
Omitir SSL	skipSSL		boolean	Si se va a omitir SSL.
Body	body		string	El cuerpo.
Tipo de cuerpo	bodyType		string	Tipo de cuerpo.
Key	key	True	string	La llave.
Importancia	value	True	string	Valor.
Bloqueado	locked		boolean	Si está bloqueado.
Fuente	source		string	Origen.
Propiedad	property		string	Propiedad .
Comparación	comparison		string	Comparación.
Objetivo	target		string	Destino.
Nombre de usuario	username	True	string	Nombre de usuario.
Contraseña	password	True	string	La contraseña.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desplazamiento de frecuencia	frequencyOffset		integer	Se usa para establecer segundos para comprobar las frecuencias en menos de 1 minutos y distribuir comprobaciones a lo largo de un intervalo de tiempo para frecuencias de más de 1 minuto. Esto funciona de la siguiente manera: las comprobaciones con una frecuencia de 0 pueden tener un valor frequencyOffset de 10, 20 o 30, lo que significa que se ejecutarán cada 10, 20 o 30 segundos. Las comprobaciones con una frecuencia inferior y igual a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.floor(frequency * 10), es decir, para una comprobación que se ejecuta cada 5 minutos, el valor de frequencyOffset máximo es 50. Las comprobaciones con una frecuencia superior a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.ceil(frequency / 60), es decir, para una comprobación que se ejecuta cada 720 minutos, el valor de frequencyOffset máximo es 12.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: CheckAPI

Actualización de una comprobación del explorador

Id. de la operación:: PutV1ChecksBrowserId

Actualiza una comprobación del explorador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name		string	Nombre de la comprobación.
Activated	activated		boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Script	script		string	Un fragmento válido de Node.js código javascript que describe una interacción del explorador con los marcos Puppeteer o Playwright.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: CheckBrowser

Actualización de una ubicación privada

Id. de la operación:: PutV1PrivatelocationsId

Actualiza una ubicación privada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Nombre	name	True	string	Nombre asignado a la ubicación privada.
Icon	icon		string	El icono.

Devoluciones

Body: commonPrivateLocationSchemaResponse

Actualización de una variable de entorno

Id. de la operación:: PutV1VariablesKey

Actualiza una variable de entorno. Usa el campo de clave como identificador para la actualización. Solo actualiza el valor y la propiedad bloqueada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Key	key	True	string	La llave.
Key	key		string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.

Devoluciones

Body: EnvironmentVariable

Actualizar un fragmento de código

Id. de la operación:: PutV1SnippetsId

Actualiza un fragmento de código.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
Nombre	name	True	string	Nombre del fragmento de código.
Script	script	True	string	El código de Node.js que interactúa con el ciclo de vida de la comprobación de API o funciona como parcial para las comprobaciones del explorador.

Devoluciones

Body: Snippet

Actualizar un grupo de comprobación

Id. de la operación:: PutV1CheckgroupsId

Actualiza un grupo de comprobación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name		string	Nombre del grupo de comprobación.
Activated	activated		boolean	Determina si las comprobaciones del grupo se están ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación en este grupo o se recupere.
Comprobar lista de etiquetas de grupo	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Comprobar lista de ubicaciones de grupo	locations		array of string	Matriz de una o varias ubicaciones del centro de datos donde ejecutar las comprobaciones.
Concurrency	concurrency		number	Determina cuántas comprobaciones se invocan simultáneamente al desencadenar un grupo de comprobación desde CI/CD o a través de la API.
URL	url		string	La dirección URL base de este grupo a la que puede hacer referencia con la variable {{GROUP_BASE_URL}} en todas las comprobaciones de grupo.
Key	key	True	string	La llave.
Importancia	value	True	string	Valor.
Bloqueado	locked		boolean	Si está bloqueado.
Fuente	source		string	Origen.
Propiedad	property		string	Propiedad .
Comparación	comparison		string	Comparación.
Objetivo	target		string	Destino.
Nombre de usuario	username	True	string	Nombre de usuario.
Contraseña	password	True	string	La contraseña.
Comprobar los valores predeterminados de comprobación del explorador de creación de grupos	browserCheckDefaults		object	Los valores predeterminados de check group create browser check.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar comprobaciones en este grupo.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en este grupo de comprobación.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se usará en la fase de configuración de una comprobación de API en este grupo.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API en este grupo.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código para ejecutarse en la fase de configuración de una comprobación de API en este grupo.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código para ejecutarse en la fase de desmontaje de una comprobación de API en este grupo.
Comprobación de ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar las comprobaciones.

Devoluciones

Body: CheckGroup

Actualizar una comprobación [EN DESUSO]

Id. de la operación:: PutV1ChecksId

[EN DESUSO] Este punto de conexión se quitará el lunes 4 de julio de 2022. En su lugar, use PUT /checks/api/{id} o PUT /checks/browser/{id}. Actualiza una nueva comprobación de API o explorador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name		string	Nombre de la comprobación.
Activated	activated		boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Comprobar tipo	checkType		string	Tipo de la comprobación.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desplazamiento de frecuencia	frequencyOffset		integer	Se usa para establecer segundos para las frecuencias de comprobación en menos de 1 minutos (solo para las comprobaciones de API) y la propagación de comprobaciones a lo largo de un intervalo de tiempo para frecuencias de más de 1 minuto. Esto funciona de la siguiente manera: las comprobaciones con una frecuencia de 0 pueden tener un valor frequencyOffset de 10, 20 o 30, lo que significa que se ejecutarán cada 10, 20 o 30 segundos. Las comprobaciones con una frecuencia inferior y igual a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.floor(frequency * 10), es decir, para una comprobación que se ejecuta cada 5 minutos, el valor de frequencyOffset máximo es 50. Las comprobaciones con una frecuencia superior a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.ceil(frequency / 60), es decir, para una comprobación que se ejecuta cada 720 minutos, el valor de frequencyOffset máximo es 12.
Comprobar solicitud	request	True	object	Solicitud de comprobación.
Script	script	True	string	El script.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: Check

Actualizar una ventana de mantenimiento

Id. de la operación:: PutV1MaintenancewindowsId

Actualiza una ventana de mantenimiento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
Nombre	name	True	string	Nombre de la ventana de mantenimiento.
Lista de etiquetas de ventana de mantenimiento	tags		array of string	Los nombres de la ventana de comprobación y de mantenimiento de grupos deben aplicarse.
Comienza en	startsAt	True	date	Fecha de inicio de la ventana de mantenimiento.
Termina en	endsAt	True	date	Fecha de finalización de la ventana de mantenimiento.
Intervalo de repetición	repeatInterval		number	Intervalo de repetición de la ventana de mantenimiento desde la primera aparición.
Repetir unidad	repeatUnit	True	string	Estrategia de repetición para la ventana de mantenimiento.
Finalizar de repetición en	repeatEndsAt		date	Fecha de finalización en la que la ventana de mantenimiento debe dejar de repetirse.

Devoluciones

Body: MaintenanceWindow

Creación de un canal de alerta

Id. de la operación:: PostV1Alertchannels

Crea un nuevo canal de alertas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id		number	Identificador.
Comprobar id.	checkId		guid	Identificador de comprobación.
Identificador de grupo	groupId		number	Identificador de grupo.
Activated	activated	True	boolean	Si se activa.
Tipo	type	True	string	Tipo.
Configuración de creación del canal de alertas	config	True	object	El canal de alerta crea la configuración.
Enviar recuperación	sendRecovery		boolean	Indica si se envía la recuperación.
Error de envío	sendFailure		boolean	Indica si se ha enviado un error.
Enviar degradado	sendDegraded		boolean	Indica si se ha degradado el envío.
Expiración de SSL	sslExpiry		boolean	Determina si se debe enviar una alerta para que expiren los certificados SSL.
Umbral de expiración de SSL	sslExpiryThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.

Devoluciones

Body: AlertChannel

Creación de un fragmento de código

Id. de la operación:: PostV1Snippets

Crea un nuevo fragmento de código.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del fragmento de código.
Script	script	True	string	El código de Node.js que interactúa con el ciclo de vida de la comprobación de API o funciona como parcial para las comprobaciones del explorador.

Devoluciones

Body: Snippet

Creación de un grupo de comprobación

Id. de la operación:: PostV1Checkgroups

Crea un nuevo grupo de comprobación. Puede agregar comprobaciones al grupo estableciendo la propiedad groupId de comprobaciones individuales.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name	True	string	Nombre del grupo de comprobación.
Activated	activated		boolean	Determina si las comprobaciones del grupo se están ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación en este grupo o se recupere.
Comprobar lista de etiquetas de grupo	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Comprobar lista de ubicaciones de grupo	locations		array of string	Matriz de una o varias ubicaciones del centro de datos donde ejecutar las comprobaciones.
Concurrency	concurrency		number	Determina cuántas comprobaciones se invocan simultáneamente al desencadenar un grupo de comprobación desde CI/CD o a través de la API.
URL	url		string	La dirección URL base de este grupo a la que puede hacer referencia con la variable {{GROUP_BASE_URL}} en todas las comprobaciones de grupo.
Key	key	True	string	La llave.
Importancia	value	True	string	Valor.
Bloqueado	locked		boolean	Si está bloqueado.
Fuente	source		string	Origen.
Propiedad	property		string	Propiedad .
Comparación	comparison		string	Comparación.
Objetivo	target		string	Destino.
Nombre de usuario	username	True	string	Nombre de usuario.
Contraseña	password	True	string	La contraseña.
Comprobar los valores predeterminados de comprobación del explorador de creación de grupos	browserCheckDefaults		object	Los valores predeterminados de check group create browser check.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar comprobaciones en este grupo.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en este grupo de comprobación.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se usará en la fase de configuración de una comprobación de API en este grupo.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API en este grupo.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código para ejecutarse en la fase de configuración de una comprobación de API en este grupo.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código para ejecutarse en la fase de desmontaje de una comprobación de API en este grupo.
Comprobación de ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar las comprobaciones.

Devoluciones

Body: CheckGroup

Creación de una comprobación de API

Id. de la operación:: PostV1ChecksApi

Crea una nueva comprobación de API. Devolverá un cuando 402 supere el límite del plan. Al usar globalAlertSetting, puede ser .alertSettingnull

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name	True	string	Nombre de la comprobación.
Activated	activated	True	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
method	method	True	string
URL	url	True	string	Dirección URL.
Seguir redirecciones	followRedirects		boolean	Indica si sigue las redirecciones.
Omitir SSL	skipSSL		boolean	Si se va a omitir SSL.
Body	body		string	El cuerpo.
bodyType	bodyType		string
Key	key	True	string	La llave.
Importancia	value	True	string	Valor.
Bloqueado	locked		boolean	Si está bloqueado.
Fuente	source		string	Origen.
Propiedad	property		string	Propiedad .
Comparación	comparison		string	Comparación.
Objetivo	target		string	Destino.
Nombre de usuario	username	True	string	Nombre de usuario.
Contraseña	password	True	string	La contraseña.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desplazamiento de frecuencia	frequencyOffset		integer	Se usa para establecer segundos para comprobar las frecuencias en menos de 1 minutos y distribuir comprobaciones a lo largo de un intervalo de tiempo para frecuencias de más de 1 minuto. Esto funciona de la siguiente manera: las comprobaciones con una frecuencia de 0 pueden tener un valor frequencyOffset de 10, 20 o 30, lo que significa que se ejecutarán cada 10, 20 o 30 segundos. Las comprobaciones con una frecuencia inferior y igual a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.floor(frequency * 10), es decir, para una comprobación que se ejecuta cada 5 minutos, el valor de frequencyOffset máximo es 50. Las comprobaciones con una frecuencia superior a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.ceil(frequency / 60), es decir, para una comprobación que se ejecuta cada 720 minutos, el valor de frequencyOffset máximo es 12.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: CheckAPI

Creación de una comprobación del explorador

Id. de la operación:: PostV1ChecksBrowser

Crea una nueva comprobación del explorador. Devolverá un cuando 402 supere el límite del plan. Al usar globalAlertSetting, puede ser .alertSettingnull

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name	True	string	Nombre de la comprobación.
Activated	activated	True	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Script	script	True	string	Un fragmento válido de Node.js código javascript que describe una interacción del explorador con los marcos Puppeteer o Playwright.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: CheckBrowser

Creación de una ubicación privada

Id. de la operación:: PostV1Privatelocations

Crea una nueva ubicación privada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre asignado a la ubicación privada.
Nombre de slug	slugName	True	string	Nombre de slug válido.
Icon	icon		string	El icono.

Devoluciones

Body: commonPrivateLocationSchemaResponse

Creación de una variable de entorno

Id. de la operación:: PostV1Variables

Crea una nueva variable de entorno.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.

Devoluciones

Body: EnvironmentVariable

Creación de una ventana de mantenimiento

Id. de la operación:: PostV1Maintenancewindows

Crea una nueva ventana de mantenimiento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre de la ventana de mantenimiento.
Lista de etiquetas de ventana de mantenimiento	tags		array of string	Los nombres de la ventana de comprobación y de mantenimiento de grupos deben aplicarse.
Comienza en	startsAt	True	date	Fecha de inicio de la ventana de mantenimiento.
Termina en	endsAt	True	date	Fecha de finalización de la ventana de mantenimiento.
Intervalo de repetición	repeatInterval		number	Intervalo de repetición de la ventana de mantenimiento desde la primera aparición.
Repetir unidad	repeatUnit	True	string	Estrategia de repetición para la ventana de mantenimiento.
Finalizar de repetición en	repeatEndsAt		date	Fecha de finalización en la que la ventana de mantenimiento debe dejar de repetirse.

Devoluciones

Body: MaintenanceWindow

Creación del desencadenador check

Id. de la operación:: PostV1TriggersChecksCheckid

Crea el desencadenador check.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.

Devoluciones

Body: CheckTrigger

Creación del desencadenador de grupo de comprobación

Id. de la operación:: PostV1TriggersCheckgroupsGroupid

Crea el desencadenador check group.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	groupId	True	integer	Identificador de grupo.

Devoluciones

Body: CheckGroupTrigger

Crear un tablero de control

Id. de la operación:: PostV1Dashboards

Crea un nuevo panel. Devolverá un 409 al intentar crear un panel con una dirección URL personalizada o un dominio personalizado que ya se haya tomado.

Parámetros

Nombre	Clave	Tipo	Description
Dirección URL personalizada	customUrl	string	Nombre de subdominio en checklyhq.com. Debe ser único en todos los usuarios.
Dominio personalizado	customDomain	string	Un dominio de usuario personalizado, por ejemplo, status.example.com. Consulte los documentos sobre cómo actualizar el uso de DNS y SSL.
Logotipo	logo	string	Dirección URL que apunta a un archivo de imagen.
Icono de favoritos	favicon	string	Dirección URL que apunta a un archivo de imagen usado como favicon del panel.
Link	link	string	Vínculo de dirección URL para redirigir cuando se hace clic en el logotipo del panel.
Header	header	string	Fragmento de texto que se muestra en la parte superior del panel.
Description	description	string	Fragmento de texto que se muestra debajo del encabezado o título del panel.
Ancho	width	string	Determina si se va a usar la pantalla completa o el foco en el centro.
Frecuencia de actualización	refreshRate	number	Frecuencia con la que se actualiza el panel en segundos.
Paginar	paginate	boolean	Determina si la paginación está activada o desactivada.
Tasa de paginación	paginationRate	number	Frecuencia con la que se desencadena la paginación en segundos.
Comprobaciones por página	checksPerPage	number	Número de comprobaciones mostradas por página.
Use y (operador)	useTagsAndOperator	boolean	Cuándo usar el operador AND para la búsqueda de etiquetas.
Ocultar etiquetas	hideTags	boolean	Mostrar u ocultar las etiquetas en el panel.
Lista de etiquetas del panel	tags	array of string	Lista de una o varias etiquetas que filtran qué comprobaciones se muestran en el panel.

Devoluciones

Body: Dashboard

Crear una comprobación [EN DESUSO]

Id. de la operación:: PostV1Checks

[EN DESUSO] Este punto de conexión se quitará el lunes 4 de julio de 2022. En su lugar, use POST /checks/api o POST /checks/browser. Crea una nueva comprobación de API o explorador. Devolverá un cuando 402 supere el límite del plan. Al usar globalAlertSettings, puede ser .alertSettingsnull

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Asignación automática de alertas	autoAssignAlerts		boolean	Determina si se agregará automáticamente una nueva comprobación como suscriptor a todos los canales de alerta existentes cuando se cree.
Nombre	name	True	string	Nombre de la comprobación.
Activated	activated	True	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted		boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck		boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail		boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations		array of string	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags		array of string	Etiquetas para organizar y filtrar comprobaciones.
Tipo de escalación	escalationType		string	Determina qué tipo de escalación se va a usar.
Umbral de ejecución con errores	failedRunThreshold		number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.
Umbral de errores de minutos	minutesFailingThreshold		number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.
Importe	amount		number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval		number	A qué intervalo deben enviarse los avisos.
Enabled	enabled		boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold		integer	En qué momento para empezar a alertar sobre certificados SSL.
Uso de la configuración de alertas globales	useGlobalAlertSettings		boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId		number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder		number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId		string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
Id. de canal de alerta	alertChannelId	True	number	Identificador del canal de alerta.
Activated	activated	True	boolean	Si se activa.
Comprobar tipo	checkType	True	string	Tipo de la comprobación.
Frecuencia	frequency		integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desplazamiento de frecuencia	frequencyOffset		integer	Se usa para establecer segundos para las frecuencias de comprobación en menos de 1 minutos (solo para las comprobaciones de API) y la propagación de comprobaciones a lo largo de un intervalo de tiempo para frecuencias de más de 1 minuto. Esto funciona de la siguiente manera: las comprobaciones con una frecuencia de 0 pueden tener un valor frequencyOffset de 10, 20 o 30, lo que significa que se ejecutarán cada 10, 20 o 30 segundos. Las comprobaciones con una frecuencia inferior y igual a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.floor(frequency * 10), es decir, para una comprobación que se ejecuta cada 5 minutos, el valor de frequencyOffset máximo es 50. Las comprobaciones con una frecuencia superior a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.ceil(frequency / 60), es decir, para una comprobación que se ejecuta cada 720 minutos, el valor de frequencyOffset máximo es 12.
Comprobar solicitud	request		object	Solicitud de comprobación.
Script	script	True	string	El script.
Key	key	True	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	True	string	Valor de la variable de entorno.
Bloqueado	locked		boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.
Id. de fragmento de código de instalación	setupSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desmontar el identificador de fragmento de código	tearDownSnippetId		number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Script de instalación local	localSetupScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript		string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime		number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
Ubicaciones privadas	privateLocations		array of string	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Devoluciones

Body: Check

Eliminación de un canal de alerta

Id. de la operación:: DeleteV1AlertchannelsId

Quita permanentemente un canal de alerta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Eliminación de una clave de API existente para una ubicación privada

Id. de la operación:: DeleteV1PrivatelocationsIdKeysKeyid

Quita permanentemente una clave de API de una ubicación privada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Id. de clave	keyId	True	string	Identificador de clave.

Eliminación de una variable de entorno

Id. de la operación:: DeleteV1VariablesKey

Quita permanentemente una variable de entorno. Usa el campo de clave como identificador para su eliminación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Key	key	True	string	La llave.

Eliminación del desencadenador check

Id. de la operación:: DeleteV1TriggersChecksCheckid

Elimina el desencadenador check.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.

Eliminación del desencadenador de grupo de comprobación

Id. de la operación:: DeleteV1TriggersCheckgroupsGroupid

Elimina el desencadenador de grupos de comprobación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	groupId	True	integer	Identificador de grupo.

Eliminar un fragmento de código

Id. de la operación:: DeleteV1SnippetsId

Quita permanentemente un fragmento de código.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Eliminar un grupo de comprobación

Id. de la operación:: DeleteV1CheckgroupsId

Quita permanentemente un grupo de comprobación. No se puede eliminar un grupo de comprobación si todavía contiene comprobaciones.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Eliminar un panel

Id. de la operación:: DeleteV1DashboardsDashboardid

Quita permanentemente un panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	dashboardId	True	string	Identificador del panel.

Eliminar una comprobación

Id. de la operación:: DeleteV1ChecksId

Quita permanentemente una comprobación de API o explorador y todos sus datos de estado y resultados relacionados.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Eliminar una ventana de mantenimiento

Id. de la operación:: DeleteV1MaintenancewindowsId

Quita permanentemente una ventana de mantenimiento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Enumera todas las ubicaciones admitidas

Id. de la operación:: GetV1Locations

Enumera todas las ubicaciones admitidas.

Devoluciones

Productos: LocationList

Enumera todos los entornos de ejecución admitidos

Id. de la operación:: GetV1Runtimes

Enumera todos los entornos de ejecución admitidos y los paquetes de NPM incluidos para comprobaciones del explorador y scripts de configuración y desmontaje para comprobaciones de API.

Devoluciones

Productos: RuntimeList

Enumera todos los resultados de la comprobación

Id. de la operación:: GetV1CheckresultsCheckid

Enumera los resultados completos y sin procesar de una comprobación específica. Mantenemos los resultados sin procesar durante 30 días. Después de 30 días se borran. Sin embargo, mantenemos los resultados inscritos durante un período indefinido. Puede filtrar por tipo de comprobación y tipo de resultado para restringir la lista. Use los to parámetros y from para especificar un intervalo de fechas (marca de tiempo de UNIX en segundos). En función del tipo de comprobación, algunos campos pueden ser NULL. Este punto de conexión devolverá datos en un período de seis horas. Si se establecen los parámetros de y a , deben estar al máximo de seis horas de diferencia. Si no se establece ninguno, consideraremos el parámetro para que sea ahora y de param a ser seis horas antes. Si solo se establece el parámetro param, se establecerá de a seis horas antes. Por el contrario, si solo se establece el parámetro from, consideraremos que param será seis horas más tarde. La limitación de velocidad se aplica a este punto de conexión, puede enviar 5 solicitudes o 10 segundos como máximo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.
De	from		date	Seleccione documentos actualizados en esta marca de tiempo de UNIX (>= fecha). El valor predeterminado es ahora : 6 horas.
Para	to		date	Seleccione alertas hasta esta marca de tiempo de UNIX (< fecha). El valor predeterminado es de 6 horas después.
Ubicación	location		string	Proporcione una ubicación del centro de datos, por ejemplo, eu-west-1 para filtrar por ubicación.
Comprobar tipo	checkType		string	Tipo de la comprobación.
Tiene errores	hasFailures		boolean	El resultado de la comprobación tiene uno o varios errores.

Devoluciones

Productos: CheckResultList

Enumeración de todos los canales de alerta

Id. de la operación:: GetV1Alertchannels

Enumera todos los canales de alerta configurados y sus comprobaciones suscritas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: AlertChannelList

Enumerar alertas para una comprobación específica

Id. de la operación:: GetV1CheckalertsCheckid

Enumera todas las alertas de una comprobación específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.
De	from		date	Seleccione documentos actualizados en esta marca de tiempo de UNIX (>= fecha). El valor predeterminado es ahora : 6 horas.
Para	to		date	Seleccione alertas hasta esta marca de tiempo de UNIX (< fecha). El valor predeterminado es de 6 horas después.

Devoluciones

Productos: CheckAlertList

Enumerar todas las alertas de la cuenta

Id. de la operación:: GetV1Checkalerts

Enumera todas las alertas de la cuenta.

Parámetros

Nombre	Clave	Tipo	Description
Limit	limit	integer	Limite el número de resultados.
Number	page	number	Número de página.
De	from	date	Seleccione documentos actualizados en esta marca de tiempo de UNIX (>= fecha). El valor predeterminado es ahora : 6 horas.
Para	to	date	Seleccione alertas hasta esta marca de tiempo de UNIX (< fecha). El valor predeterminado es de 6 horas después.

Devoluciones

Productos: CheckAlertList

Enumerar todas las comprobaciones

Id. de la operación:: GetV1Checks

Enumera todas las comprobaciones actuales de la cuenta.

Parámetros

Nombre	Clave	Tipo	Description
Limit	limit	integer	Limite el número de resultados.
Number	page	number	Número de página.
Filtro de dirección URL de comprobación de API	apiCheckUrlFilterPattern	string	Filtra los resultados por una cadena contenida en la dirección URL de una comprobación de API, por ejemplo, un dominio como www.myapp.com. Solo devuelve comprobaciones de API.

Devoluciones

Productos: CheckList

Enumerar todas las ubicaciones privadas

Id. de la operación:: GetV1Privatelocations

Enumera todas las ubicaciones privadas de la cuenta.

Devoluciones

Productos: privateLocationsListSchema

Enumerar todas las variables de entorno

Id. de la operación:: GetV1Variables

Enumera todas las variables de entorno actuales de la cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: EnvironmentVariableList

Enumerar todas las ventanas de mantenimiento

Id. de la operación:: GetV1Maintenancewindows

Enumera todas las ventanas de mantenimiento de su cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Lista de ventanas de mantenimiento.

Productos: MaintenanceWindowList

Enumerar todos los estados de comprobación

Id. de la operación:: GetV1Checkstatuses

Muestra la información de estado actual de todas las comprobaciones de la cuenta. Los registros de estado de comprobación se actualizan continuamente a medida que se producen nuevos resultados de comprobación.

Devoluciones

Productos: CheckStatusList

Enumerar todos los fragmentos de código

Id. de la operación:: GetV1Snippets

Enumera todos los fragmentos de código actuales de la cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: SnippetList

Enumerar todos los grupos de comprobación

Id. de la operación:: GetV1Checkgroups

Enumera todos los grupos de comprobación actuales de la cuenta. La propiedad checks es una matriz de comprobación del UUID para hacer referencia conveniente. Es de solo lectura y no se puede usar para agregar comprobaciones a un grupo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: CheckGroupList

Enumerar todos los paneles

Id. de la operación:: GetV1Dashboards

Enumera todos los paneles actuales de la cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: DashboardsList

Genera un informe con estadísticas agregadas para comprobaciones y grupos de comprobación

Id. de la operación:: GetV1Reporting

Genera un informe con estadísticas agregadas para todas las comprobaciones o un conjunto filtrado de comprobaciones a través de un período de tiempo especificado.

Parámetros

Nombre	Clave	Tipo	Description
De	from	date	Hora de inicio personalizada de la ventana de informes en formato de marca de tiempo unix. Si se establece una marca de tiempo personalizada, se invalida el uso de cualquier valor preestablecidoWindow.
Para	to	date	Hora de finalización personalizada de la ventana de informes en formato de marca de tiempo unix. Establecer una marca de tiempo personalizada invalida el uso de cualquier valor preestablecidoWindow.
Ventana preestablecida	presetWindow	string	Las ventanas de informes preestablecidas se usan para generar rápidamente informes en ventanas usadas con frecuencia. Se puede invalidar mediante una marca de tiempo personalizada a y desde la marca de tiempo.
Filtrar por etiquetas	filterByTags	array	Use etiquetas para filtrar las comprobaciones que desea ver en el informe.
Desactivado	deactivated	boolean	Filtra las comprobaciones por estado activado.

Devoluciones

Productos: ReportingList

Genera un informe personalizable para todas las métricas de Comprobación del explorador.

Id. de la operación:: GetV2ReportingBrowserchecksId

Genera un informe con estadísticas agregadas o no agregadas para una comprobación de explorador específica en un período de tiempo especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
De	from		date	Hora de inicio personalizada de la ventana de informes en formato de marca de tiempo unix. Si se establece una marca de tiempo personalizada, se invalida el uso de cualquier valor preestablecidoWindow.
Para	to		date	Hora de finalización personalizada de la ventana de informes en formato de marca de tiempo unix. Establecer una marca de tiempo personalizada invalida el uso de cualquier valor preestablecidoWindow.
Ventana preestablecida	presetWindow		string	Las ventanas de informes preestablecidas se usan para generar rápidamente informes en ventanas usadas con frecuencia. Se puede invalidar mediante una marca de tiempo personalizada a y desde la marca de tiempo.
Intervalo de agregación	aggregationInterval		number	Intervalo de tiempo que se va a usar para agregar métricas en minutos. Por ejemplo, cinco minutos es 300, 24 horas es 1440.
Agrupar por	groupBy		string	Determina cómo se agrupan los datos de la serie.
Filtrar por estado	filterByStatus		array	Use el estado para filtrar los datos de resultados de comprobación con errores o correctos.
Metrics	metrics		array	opciones de métricas para las comprobaciones del explorador.

Devoluciones

Atributos.

Attributes: object

Generación de una nueva clave de API para una ubicación privada

Id. de la operación:: PostV1PrivatelocationsIdKeys

Crea una clave de API en la ubicación privada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Body: privateLocationKeys

Muestra los detalles de un entorno de ejecución específico.

Id. de la operación:: GetV1RuntimesId

Muestra los detalles de todos los paquetes de NPM incluidos y su versión para un entorno de ejecución específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Body: Runtime

Obtención de métricas de estado de ubicación privada desde un período de tiempo

Id. de la operación:: GetV1PrivatelocationsIdMetrics

Obtenga métricas de estado de ubicación privada desde un período de tiempo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
De	from	True	date	Seleccione las métricas a partir de esta marca de tiempo de UNIX. Debe ser inferior a 15 días atrás.
Para	to	True	date	Seleccione métricas hasta esta marca de tiempo de UNIX.

Devoluciones

Body: privateLocationsMetricsHistoryResponseSchema

Obtención del desencadenador check

Id. de la operación:: GetV1TriggersChecksCheckid

Busca el desencadenador check.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.

Devoluciones

Body: CheckTrigger

Obtención del desencadenador del grupo de comprobación

Id. de la operación:: GetV1TriggersCheckgroupsGroupid

Busca el desencadenador de grupo check.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	groupId	True	integer	Identificador de grupo.

Devoluciones

Body: CheckGroupTrigger

Obtención del distintivo de estado de comprobación

Id. de la operación:: GetV1BadgesChecksCheckid

Obtener la notificación de estado de comprobación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.
Style	style		string	Estilo.
Tema	theme		string	Tema.
Tiempo de respuesta	responseTime		boolean	Tiempo de respuesta.

Devoluciones

response: string

Obtención del distintivo de estado del grupo

Id. de la operación:: GetV1BadgesGroupsGroupid

Obtener el distintivo de estado del grupo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	groupId	True	integer	Identificador de grupo.
Style	style		string	Estilo.
Tema	theme		string	Tema.
Tiempo de respuesta	responseTime		boolean	Tiempo de respuesta.

Devoluciones

response: string

Quitar una ubicación privada

Id. de la operación:: DeleteV1PrivatelocationsId

Quita permanentemente una ubicación privada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Recuperación de los detalles del estado de comprobación

Id. de la operación:: GetV1CheckstatusesCheckid

Muestra la información de estado actual de una comprobación específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.

Devoluciones

Body: CheckStatus

Recuperación de un canal de alerta

Id. de la operación:: GetV1AlertchannelsId

Mostrar detalles de un canal de alerta específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Devoluciones

Body: AlertChannel

Recuperación de un fragmento de código

Id. de la operación:: GetV1SnippetsId

Mostrar detalles de un fragmento de código específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Devoluciones

Body: Snippet

Recuperación de un grupo de comprobación

Id. de la operación:: GetV1CheckgroupsId

Mostrar detalles de un grupo de comprobación específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Devoluciones

Body: CheckGroup

Recuperación de un resultado de comprobación

Id. de la operación:: GetV1CheckresultsCheckidCheckresultid

Mostrar detalles de un resultado de comprobación específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Comprobar id.	checkId	True	string	Identificador de comprobación.
Comprobar el id. de resultado	checkResultId	True	string	Identificador de resultado de comprobación.

Devoluciones

Body: CheckResult

Recuperación de una comprobación en un grupo específico con la configuración de grupo aplicada

Id. de la operación:: GetV1CheckgroupsGroupidChecksCheckid

Muestra los detalles de una comprobación en un grupo de comprobación específico con la configuración de grupo aplicada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de grupo	groupId	True	integer	Identificador de grupo.
Comprobar id.	checkId	True	string	Identificador de comprobación.

Devoluciones

Body: CheckGroupCheck

Recuperación de una ubicación privada

Id. de la operación:: GetV1PrivatelocationsId

Mostrar detalles de una ubicación privada específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Body: privatelocationschema

Recuperación de una variable de entorno

Id. de la operación:: GetV1VariablesKey

Mostrar detalles de una variable de entorno específica. Usa el campo de clave para la selección.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Key	key	True	string	La llave.

Devoluciones

Body: EnvironmentVariable

Recuperar todas las comprobaciones de un grupo específico con la configuración de grupo aplicada

Id. de la operación:: GetV1CheckgroupsIdChecks

Enumera todas las comprobaciones de un grupo de comprobación específico con la configuración de grupo aplicada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.
Limit	limit		integer	Limite el número de resultados.
Number	page		number	Número de página.

Devoluciones

Productos: Model8

Recuperar una comprobación

Id. de la operación:: GetV1ChecksId

Muestra los detalles de una comprobación específica de la API o del explorador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Body: Check

Recuperar una ventana de mantenimiento

Id. de la operación:: GetV1MaintenancewindowsId

Mostrar detalles de una ventana de mantenimiento específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	integer	Identificador.

Devoluciones

Body: MaintenanceWindow

Definiciones

AlertChannelConfig

Configuración del canal de alerta.

Nombre	Ruta de acceso	Tipo	Description
Configuración del canal de alerta		object	Configuración del canal de alerta.

AlertChanelSubscription

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Comprobar id.	checkId	guid	Identificador de comprobación.
Identificador de grupo	groupId	number	Identificador de grupo.
Activated	activated	boolean	Si se activa.

AlertChanelSubscriptionList

Todas las comprobaciones se suscriben a este canal.

Nombre	Ruta de acceso	Tipo	Description
Productos		AlertChanelSubscription

AlertChannel

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Tipo	type	string	Tipo de canal de alerta, es decir, CORREO ELECTRÓNICO o SLACK.
Configuración del canal de alerta	config	AlertChannelConfig	Configuración del canal de alerta.
Lista de suscripciones del canal de alertas	subscriptions	AlertChanelSubscriptionList	Todas las comprobaciones se suscriben a este canal.
Enviar recuperación	sendRecovery	boolean	Indica si se envía la recuperación.
Error de envío	sendFailure	boolean	Indica si se ha enviado un error.
Enviar degradado	sendDegraded	boolean	Indica si se ha degradado el envío.
Expiración de SSL	sslExpiry	boolean	Determina si se debe enviar una alerta para que expiren los certificados SSL.
Umbral de expiración de SSL	sslExpiryThreshold	integer	En qué momento para empezar a alertar sobre certificados SSL.
Creado en	created_at	date-time	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

AlertChannelList

Nombre	Ruta de acceso	Tipo	Description
Productos		AlertChannel

CheckAlert

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único de esta alerta.
Nombre	name	string	Nombre de la comprobación.
Comprobar id.	checkId	string	El identificador de comprobación de esta alerta pertenece.
AlertType	alertType	string	Tipo de alerta.
Comprobar tipo	checkType	string	Tipo de la comprobación.
Ubicación de ejecución	runLocation	string	Desde qué ubicación del centro de datos se desencadenó esta alerta de comprobación.
Tiempo de respuesta	responseTime	number	Describe el tiempo necesario para ejecutar las partes pertinentes de esta comprobación. La hora del sistema del temporizador de instalación necesaria para empezar a ejecutar esta comprobación en el back-end checkly no forma parte de esto.
Error	error	string	Los mensajes de error específicos que formaban parte de la comprobación con errores desencadenaban la alerta.
Código de estado	statusCode	string	El código de estado de la respuesta. Solo se aplica a las comprobaciones de API.
Creado en	created_at	date	Fecha y hora en que se creó esta alerta de comprobación.
Iniciado en	startedAt	date	Fecha y hora en que se inició esta alerta de comprobación.

CheckAlertList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlert

CheckGroupTagList

Etiquetas para organizar y filtrar comprobaciones.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckGroupLocationList

Matriz de una o varias ubicaciones del centro de datos donde ejecutar las comprobaciones.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

KeyValue

Nombre	Ruta de acceso	Tipo	Description
Key	key	string	La llave.
Importancia	value	string	Valor.
Bloqueado	locked	boolean	Si está bloqueado.

HeaderList

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

QueryParameterList

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

Aserción

Nombre	Ruta de acceso	Tipo	Description
Fuente	source	string	Origen.
Propiedad	property	string	Propiedad .
Comparación	comparison	string	Comparación.
Objetivo	target	string	Destino.

AssertionList

Compruebe la documentación principal sobre las aserciones para ver valores específicos, como expresiones regulares y descriptores de ruta de acceso JSON, que puede usar en el campo de propiedad.

Nombre	Ruta de acceso	Tipo	Description
Productos		Assertion

BasicAuth

Nombre	Ruta de acceso	Tipo	Description
Nombre de usuario	username	string	Nombre de usuario.
Contraseña	password	string	La contraseña.

CheckGroupAPICheckDefaults

Nombre	Ruta de acceso	Tipo	Description
URL	url	string	La dirección URL base de este grupo a la que puede hacer referencia con la variable {{GROUP_BASE_URL}} en todas las comprobaciones de grupo.
headers	headers	HeaderList
queryParameters	queryParameters	QueryParameterList
Lista de aserciones	assertions	AssertionList	Compruebe la documentación principal sobre las aserciones para ver valores específicos, como expresiones regulares y descriptores de ruta de acceso JSON, que puede usar en el campo de propiedad.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

El explorador check group comprueba los valores predeterminados.

Nombre	Ruta de acceso	Tipo	Description
Comprobar los valores predeterminados de comprobación del explorador de grupo		object	El explorador check group comprueba los valores predeterminados.

EnvironmentVariable

Nombre	Ruta de acceso	Tipo	Description
Key	key	string	Clave de la variable de entorno (este valor no se puede cambiar).
Importancia	value	string	Valor de la variable de entorno.
Bloqueado	locked	boolean	Solo se usa en la interfaz de usuario para ocultar el valor como una contraseña.

EnvironmentVariableList

Nombre	Ruta de acceso	Tipo	Description
Productos		EnvironmentVariable

AlertSettingsRunBasedEscalation

Nombre	Ruta de acceso	Tipo	Description
Umbral de ejecución con errores	failedRunThreshold	number	Después de que se produzca un error en la comprobación consecutiva, se debe enviar una notificación de alerta.

AlertSettingsTimeBasedEscalation

Nombre	Ruta de acceso	Tipo	Description
Umbral de errores de minutos	minutesFailingThreshold	number	Después de cuántos minutos después de que se inicie una comprobación, se debería enviar una alerta.

AlertSettingsReminders

Nombre	Ruta de acceso	Tipo	Description
Importe	amount	number	Número de recordatorios que se van a enviar después de la notificación de alerta inicial.
Intervalo	interval	number	A qué intervalo deben enviarse los avisos.

AlertSettingsSSLCertificates

[EN DESUSO] sslCertificates está en desuso y ya no se usa. Omitirlo se quitará en una versión futura.

Nombre	Ruta de acceso	Tipo	Description
Enabled	enabled	boolean	Determina si se deben enviar notificaciones de alerta para que expiren los certificados SSL.
Umbral de alerta	alertThreshold	integer	En qué momento para empezar a alertar sobre certificados SSL.

CheckGroupAlertSettings

Configuración de alertas.

Nombre	Ruta de acceso	Tipo	Description
Tipo de escalación	escalationType	string	Determina qué tipo de escalación se va a usar.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Recordatorios	reminders	AlertSettingsReminders
Certificados SSL de configuración de alertas	sslCertificates	AlertSettingsSSLCertificates	[EN DESUSO] `sslCertificates` está en desuso y ya no se usa. Omitirlo se quitará en una versión futura.

Model1

Suscripción del canal de alertas.

Nombre	Ruta de acceso	Tipo	Description
Id. de canal de alerta	alertChannelId	number	Identificador del canal de alerta.
Activated	activated	boolean	Si se activa.

AlertChannelSubscriptionCreateList

Lista de suscripciones del canal de alertas.

Nombre	Ruta de acceso	Tipo	Description
Suscripción del canal de alertas		Model1	Suscripción del canal de alertas.

privateLocations

Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckGroup

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Nombre	name	string	Nombre del grupo de comprobación.
Activated	activated	boolean	Determina si las comprobaciones del grupo se están ejecutando o no.
Silenciado	muted	boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación en este grupo o se recupere.
Comprobar lista de etiquetas de grupo	tags	CheckGroupTagList	Etiquetas para organizar y filtrar comprobaciones.
Comprobar lista de ubicaciones de grupo	locations	CheckGroupLocationList	Matriz de una o varias ubicaciones del centro de datos donde ejecutar las comprobaciones.
Concurrency	concurrency	number	Determina cuántas comprobaciones se invocan simultáneamente al desencadenar un grupo de comprobación desde CI/CD o a través de la API.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Comprobar los valores predeterminados de comprobación del explorador de grupo	browserCheckDefaults	CheckGroupBrowserCheckDefaults	El explorador check group comprueba los valores predeterminados.
environmentVariables	environmentVariables	EnvironmentVariableList
Doble comprobación	doubleCheck	boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Uso de la configuración de alertas globales	useGlobalAlertSettings	boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en este grupo de comprobación.
Comprobar la configuración de alertas de grupo	alertSettings	CheckGroupAlertSettings	Configuración de alertas.
Lista de creación de suscripciones de canal de alertas	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Lista de suscripciones del canal de alertas.
Id. de fragmento de código de instalación	setupSnippetId	number	Referencia de identificador a un fragmento de código que se usará en la fase de configuración de una comprobación de API en este grupo.
Desmontar el identificador de fragmento de código	tearDownSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API en este grupo.
Script de instalación local	localSetupScript	string	Un fragmento válido de Node.js código para ejecutarse en la fase de configuración de una comprobación de API en este grupo.
Script de anulación local	localTearDownScript	string	Un fragmento válido de Node.js código para ejecutarse en la fase de desmontaje de una comprobación de API en este grupo.
Identificador de tiempo de ejecución	runtimeId	string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar comprobaciones en este grupo.
Ubicaciones privadas	privateLocations	privateLocations	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

CheckGroupList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckGroup

CheckLocationList

Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckTagList

Etiquetas para organizar y filtrar comprobaciones.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckAlertSettings

Configuración de alertas.

Nombre	Ruta de acceso	Tipo	Description
Tipo de escalación	escalationType	string	Determina qué tipo de escalación se va a usar.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Recordatorios	reminders	AlertSettingsReminders
Certificados SSL de configuración de alertas	sslCertificates	AlertSettingsSSLCertificates	[EN DESUSO] `sslCertificates` está en desuso y ya no se usa. Omitirlo se quitará en una versión futura.

CheckAlertChannelSubscription

Nombre	Ruta de acceso	Tipo	Description
Id. de canal de alerta	alertChannelId	number	Identificador del canal de alerta.
Activated	activated	boolean	Si se activa.

CheckAlertChannelSubscriptionList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlertChannelSubscription

CheckRequest

Solicitud de comprobación.

Nombre	Ruta de acceso	Tipo	Description
Comprobar solicitud		object	Solicitud de comprobación.

CheckEnvironmentVariableList

Pares clave-valor para establecer variables de entorno durante la ejecución de la comprobación. Solo son relevantes para las comprobaciones del explorador. Use variables de entorno globales siempre que sea posible.

Nombre	Ruta de acceso	Tipo	Description
Productos		EnvironmentVariable

CheckAlertEmail

Nombre	Ruta de acceso	Tipo	Description
Dirección	address	string	Dirección.

CheckAlertEmailList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlertEmail

Model4

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

Model5

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

CheckAlertWebhook

Nombre	Ruta de acceso	Tipo	Description
Nombre	name	string	Nombre.
URL	url	string	Dirección URL.
Método	method	string	Método .
headers	headers	Model4
queryParameters	queryParameters	Model5

CheckAlertWebhookList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlertWebhook

CheckAlertSlack

Nombre	Ruta de acceso	Tipo	Description
URL	url	string	Dirección URL.

CheckAlertSlackList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlertSlack

CheckAlertSMS

Nombre	Ruta de acceso	Tipo	Description
Number	number	string	Número.
Nombre	name	string	Nombre.

CheckAlertSMSList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAlertSMS

CheckAlertChannels

Nombre	Ruta de acceso	Tipo
Correo electrónico	email	CheckAlertEmailList
webhook (punto de enlace web)	webhook	CheckAlertWebhookList
flojo	slack	CheckAlertSlackList
mensaje de texto	sms	CheckAlertSMSList

CheckGroupCheck

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador.
Nombre	name	string	Nombre de la comprobación.
Activated	activated	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted	boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck	boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail	boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations	CheckLocationList	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags	CheckTagList	Etiquetas para organizar y filtrar comprobaciones.
Comprobación de la configuración de alertas	alertSettings	CheckAlertSettings	Configuración de alertas.
Uso de la configuración de alertas globales	useGlobalAlertSettings	boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId	number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder	number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId	string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Comprobar tipo	checkType	string	Tipo de la comprobación.
Frecuencia	frequency	integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desplazamiento de frecuencia	frequencyOffset	integer	Desplazamiento de frecuencia.
Comprobar solicitud	request	CheckRequest	Solicitud de comprobación.
Script	script	string	El script.
Comprobar lista de variables de entorno	environmentVariables	CheckEnvironmentVariableList	Pares clave-valor para establecer variables de entorno durante la ejecución de la comprobación. Solo son relevantes para las comprobaciones del explorador. Use variables de entorno globales siempre que sea posible.
Id. de fragmento de código de instalación	setupSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desmontar el identificador de fragmento de código	tearDownSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Script de instalación local	localSetupScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
alertChannels	alertChannels	CheckAlertChannels
Ubicaciones privadas	privateLocations	privateLocations	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

Model8

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckGroupCheck

Afirmaciones

Lista de aserciones de comprobación de API.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

headers

Encabezados.

Nombre	Ruta de acceso	Tipo	Description
Headers		object	Encabezados.

parámetros

Parámetros.

Nombre	Ruta de acceso	Tipo	Description
Parámetros		object	Parámetros.

request

Solicitud de la API.

Nombre	Ruta de acceso	Tipo	Description
method	method	string
URL	url	string
datos	data	string
Headers	headers	headers	Encabezados.
Parámetros	params	params	Parámetros.

Sincronizaciones

Los tiempos.

Nombre	Ruta de acceso	Tipo	Description
Sincronizaciones		object	Los tiempos.

timingPhases

Fases de tiempo.

Nombre	Ruta de acceso	Tipo	Description
Fases de control de tiempo		object	Fases de tiempo.

response

Respuesta de la API.

Nombre	Ruta de acceso	Tipo	Description
Estado	status	number	Estado.
Texto de estado	statusText	string	Texto de estado.
Body	body	string	El cuerpo.
Headers	headers	headers	Encabezados.
Sincronizaciones	timings	timings	Los tiempos.
Fases de control de tiempo	timingPhases	timingPhases	Fases de tiempo.

jobLog

Registro de trabajos.

Nombre	Ruta de acceso	Tipo	Description
Registro de trabajos		object	Registro de trabajos.

jobAssets

Recursos generados a partir de la ejecución de comprobación.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckResultAPI

Datos de respuesta de una comprobación de API.

Nombre	Ruta de acceso	Tipo	Description
Assertions	assertions	assertions	Lista de aserciones de comprobación de API.
Solicitud	request	request	Solicitud de la API.
Respuesta	response	response	Respuesta de la API.
Error de solicitud	requestError	string	Describe si se produjo un error en la solicitud.
Registro de trabajos	jobLog	jobLog	Registro de trabajos.
Recursos de trabajo	jobAssets	jobAssets	Recursos generados a partir de la ejecución de comprobación.

Errores

Lista de errores en la ejecución de comprobación.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

Model9

Compruebe los resultados del registro de ejecución.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

traceSummary

Resumen del seguimiento.

Nombre	Ruta de acceso	Tipo	Description
Resumen de seguimiento		object	Resumen del seguimiento.

pages

Lista de páginas usadas en la ejecución de comprobación.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

CheckResultBrowser

Datos de respuesta de una comprobación del explorador.

Nombre	Ruta de acceso	Tipo	Description
Tipo	type	string	El tipo de marco de trabajo que usa la comprobación.
Errors	errors	errors	Lista de errores en la ejecución de comprobación.
Hora de finalización	endTime	number	Hora de finalización de la ejecución de comprobación.
Hora de comienzo	startTime	number	Hora de inicio de la ejecución de comprobación.
Versión en tiempo de ejecución	runtimeVersion	string	Versión activa del entorno de ejecución.
Comprobación del registro de ejecución	jobLog	Model9	Compruebe los resultados del registro de ejecución.
Recursos de trabajo	jobAssets	jobAssets	Recursos generados a partir de la ejecución de comprobación.
Resumen de seguimiento	traceSummary	traceSummary	Resumen del seguimiento.
Páginas	pages	pages	Lista de páginas usadas en la ejecución de comprobación.

CheckResult

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único de este resultado.
Nombre	name	string	Nombre de la comprobación.
Comprobar id.	checkId	string	Identificador de la comprobación.
Tiene errores	hasFailures	boolean	Describe si se ha producido algún error durante esta ejecución de comprobación. Este debe ser el foco principal para evaluar el comportamiento de la API o de la comprobación del explorador. Las aserciones que producen errores, tiempos de espera o scripts con errores se resuelven en este valor siendo true.
Tiene errores	hasErrors	boolean	Describe si se ha producido un error interno en el back-end de Checkly. Esto debe ser false en casi todos los casos.
Está degradado	isDegraded	boolean	Una comprobación se degrada si supera el límite de degradación establecido por el campo degradedResponseTime en la comprobación. Solo se aplica a las comprobaciones de API.
Tiempo máximo de respuesta	overMaxResponseTime	boolean	Establézcalo en true si el tiempo de respuesta supera el límite establecido por el campo maxResponseTime en la comprobación. Solo se aplica a las comprobaciones de API.
Ubicación de ejecución	runLocation	string	A qué ubicación del centro de datos se originó este resultado de comprobación.
Iniciado en	startedAt	date-time	Se inició a la vez.
Detenido en	stoppedAt	date-time	El detenido en el momento.
Creado en	created_at	date-time	Cuando se crea en .
Tiempo de respuesta	responseTime	number	Describe el tiempo necesario para ejecutar las partes pertinentes de esta comprobación. La hora del sistema del temporizador de instalación necesaria para empezar a ejecutar esta comprobación en el back-end checkly no forma parte de esto.
Check Result API	apiCheckResult	CheckResultAPI	Datos de respuesta de una comprobación de API.
Resultado de la comprobación del explorador	browserCheckResult	CheckResultBrowser	Datos de respuesta de una comprobación del explorador.
Comprobación del identificador de ejecución	checkRunId	number	Identificador de la ejecución de comprobación específica que creó este resultado de comprobación.
Intentos	attempts	number	Frecuencia con la que se reintentó esta comprobación. Esto será mayor que 0 cuando se habilite la comprobación doble.

CheckResultList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckResult

CheckStatus

Nombre	Ruta de acceso	Tipo	Description
Nombre	name	string	Nombre de la comprobación.
Comprobar id.	checkId	string	El identificador de comprobar este estado pertenece.
Tiene errores	hasFailures	boolean	Describe si se produce un error en esta comprobación. Si alguna de las aserciones de una comprobación de API produce un error, este valor es true. Si se produce un error en una comprobación del explorador por cualquier motivo, esto es cierto.
Tiene errores	hasErrors	boolean	Describe si debido a algún error fuera de la operación normal, se produce un error en esta comprobación. Esto debe ser extremadamente raro y solo cuando se produce un error en el back-end checkly.
Está degradado	isDegraded	boolean	Una comprobación se degrada si supera el límite de degradación establecido por el campo degradedResponseTime en la comprobación. Solo se aplica a las comprobaciones de API.
Ejecución más larga	longestRun	number	El tiempo de respuesta registrado más largo para esta comprobación.
Ejecución más corta	shortestRun	number	El tiempo de respuesta más corto registrado para esta comprobación.
Ubicación de última ejecución	lastRunLocation	string	¿En qué ubicación se ejecutó esta comprobación por última vez?
Último identificador de ejecución de comprobación	lastCheckRunId	string	Identificador de incremento único para cada ejecución de comprobación.
Días ssl restantes	sslDaysRemaining	number	Cuántos días permanecen hasta que expire el certificado SSL actual.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

CheckStatusList

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckStatus

Check

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador.
Nombre	name	string	Nombre de la comprobación.
Activated	activated	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted	boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck	boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail	boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations	CheckLocationList	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags	CheckTagList	Etiquetas para organizar y filtrar comprobaciones.
Comprobación de la configuración de alertas	alertSettings	CheckAlertSettings	Configuración de alertas.
Uso de la configuración de alertas globales	useGlobalAlertSettings	boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId	number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder	number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId	string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Comprobar tipo	checkType	string	Tipo de la comprobación.
Frecuencia	frequency	integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desplazamiento de frecuencia	frequencyOffset	integer	Desplazamiento de frecuencia.
Comprobar solicitud	request	CheckRequest	Solicitud de comprobación.
Script	script	string	El script.
Comprobar lista de variables de entorno	environmentVariables	CheckEnvironmentVariableList	Pares clave-valor para establecer variables de entorno durante la ejecución de la comprobación. Solo son relevantes para las comprobaciones del explorador. Use variables de entorno globales siempre que sea posible.
Id. de fragmento de código de instalación	setupSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Desmontar el identificador de fragmento de código	tearDownSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Script de instalación local	localSetupScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
alertChannels	alertChannels	CheckAlertChannels
Ubicaciones privadas	privateLocations	privateLocations	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

CheckList

Nombre	Ruta de acceso	Tipo	Description
Productos		Check

Model14

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

Model15

Nombre	Ruta de acceso	Tipo	Description
Productos		KeyValue

Model16

Determina la solicitud que se va a ejecutar la comprobación.

Nombre	Ruta de acceso	Tipo	Description
method	method	string
URL	url	string	Dirección URL.
Seguir redireccionamientos	followRedirects	boolean	Indica si se deben seguir las redirecciones.
Omitir SSL	skipSSL	boolean	Si se va a omitir SSL.
Body	body	string	El cuerpo.
Tipo de cuerpo	bodyType	string	Tipo de cuerpo.
headers	headers	Model14
queryParameters	queryParameters	Model15
Lista de aserciones	assertions	AssertionList	Compruebe la documentación principal sobre las aserciones para ver valores específicos, como expresiones regulares y descriptores de ruta de acceso JSON, que puede usar en el campo de propiedad.
basicAuth	basicAuth	BasicAuth

CheckAPI

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador.
Nombre	name	string	Nombre de la comprobación.
Activated	activated	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted	boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck	boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail	boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations	CheckLocationList	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags	CheckTagList	Etiquetas para organizar y filtrar comprobaciones.
Comprobación de la configuración de alertas	alertSettings	CheckAlertSettings	Configuración de alertas.
Uso de la configuración de alertas globales	useGlobalAlertSettings	boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId	number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder	number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId	string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Comprobar solicitud	request	Model16	Determina la solicitud que se va a ejecutar la comprobación.
Frecuencia	frequency	integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Desplazamiento de frecuencia	frequencyOffset	integer	Se usa para establecer segundos para las frecuencias de comprobación en menos de 1 minutos (solo para las comprobaciones de API) y la propagación de comprobaciones a lo largo de un intervalo de tiempo para frecuencias de más de 1 minuto. Esto funciona de la siguiente manera: las comprobaciones con una frecuencia de 0 pueden tener un valor frequencyOffset de 10, 20 o 30, lo que significa que se ejecutarán cada 10, 20 o 30 segundos. Las comprobaciones con una frecuencia inferior y igual a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.floor(frequency * 10), es decir, para una comprobación que se ejecuta cada 5 minutos, el valor de frequencyOffset máximo es 50. Las comprobaciones con una frecuencia superior a 60 pueden tener un valor frequencyOffset entre 1 y un valor máximo basado en la fórmula Math.ceil(frequency / 60), es decir, para una comprobación que se ejecuta cada 720 minutos, el valor de frequencyOffset máximo es 12.
Desmontar el identificador de fragmento de código	tearDownSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de desmontaje de una comprobación de API.
Id. de fragmento de código de instalación	setupSnippetId	number	Referencia de identificador a un fragmento de código que se va a usar en la fase de configuración de una comprobación de API.
Script de instalación local	localSetupScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de instalación.
Script de anulación local	localTearDownScript	string	Un fragmento válido de Node.js código que se va a ejecutar en la fase de desmontaje.
Tiempo de respuesta degradado	degradedResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar degradado una comprobación.
Tiempo máximo de respuesta	maxResponseTime	number	Tiempo de respuesta en milisegundos en los que se debe considerar un error en una comprobación.
Ubicaciones privadas	privateLocations	privateLocations	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.
Comprobar tipo	checkType	string	Tipo de comprobación.
alertChannels	alertChannels	CheckAlertChannels
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

CheckBrowser

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador.
Nombre	name	string	Nombre de la comprobación.
Activated	activated	boolean	Determina si la comprobación se está ejecutando o no.
Silenciado	muted	boolean	Determina si se enviarán notificaciones cuando se produzca un error en una comprobación o se recupere.
Doble comprobación	doubleCheck	boolean	Si se establece en true, se desencadenará un reintento cuando se produzca un error en una comprobación de la región con errores y otra región seleccionada aleatoriamente antes de marcar la comprobación como errónea.
Debe producir un error	shouldFail	boolean	Permite invertir el comportamiento de cuando se considera que se produce un error en una comprobación. Permite validar el estado de error como 404.
Comprobar lista de ubicaciones	locations	CheckLocationList	Matriz de una o varias ubicaciones del centro de datos en las que ejecutar esta comprobación.
Comprobar lista de etiquetas	tags	CheckTagList	Etiquetas para organizar y filtrar comprobaciones.
Comprobación de la configuración de alertas	alertSettings	CheckAlertSettings	Configuración de alertas.
Uso de la configuración de alertas globales	useGlobalAlertSettings	boolean	Cuando es true, se usará la configuración de alerta de nivel de cuenta, no la configuración de alerta definida en esta comprobación.
Identificador de grupo	groupId	number	Identificador del grupo de comprobación del que forma parte esta comprobación.
Orden de grupo	groupOrder	number	Posición de esta comprobación en un grupo de comprobación. Determina en qué orden se ejecutan las comprobaciones cuando se desencadena un grupo desde la API o desde CI/CD.
Identificador de tiempo de ejecución	runtimeId	string	La versión en tiempo de ejecución, es decir, un conjunto fijo de dependencias en tiempo de ejecución, que se usa para ejecutar esta comprobación.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Comprobar tipo	checkType	string	Tipo de comprobación.
Frecuencia	frequency	integer	Frecuencia con la que se debe ejecutar la comprobación en cuestión de minutos.
Script	script	string	Un fragmento válido de Node.js código javascript que describe una interacción del explorador con los marcos Puppeteer o Playwright.
Ubicaciones privadas	privateLocations	privateLocations	Matriz de una o varias ubicaciones privadas donde ejecutar la comprobación.
alertChannels	alertChannels	CheckAlertChannels
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

DashboardTagList

Lista de una o varias etiquetas que filtran qué comprobaciones se muestran en el panel.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

Dashboard

Nombre	Ruta de acceso	Tipo	Description
Dominio personalizado	customDomain	string	Un dominio de usuario personalizado, por ejemplo, status.example.com. Consulte los documentos sobre cómo actualizar el uso de DNS y SSL.
Dirección URL personalizada	customUrl	string	Nombre de subdominio en checklyhq.com. Debe ser único en todos los usuarios.
Logotipo	logo	string	Dirección URL que apunta a un archivo de imagen.
Icono de favoritos	favicon	string	Dirección URL que apunta a un archivo de imagen usado como favicon del panel.
Link	link	string	Vínculo de dirección URL para redirigir cuando se hace clic en el logotipo del panel.
Header	header	string	Fragmento de texto que se muestra en la parte superior del panel.
Description	description	string	Fragmento de texto que se muestra debajo del encabezado o título del panel.
Ancho	width	string	Determina si se va a usar la pantalla completa o el foco en el centro.
Frecuencia de actualización	refreshRate	number	Frecuencia con la que se actualiza el panel en segundos.
Paginar	paginate	boolean	Determina si la paginación está activada o desactivada.
Tasa de paginación	paginationRate	number	Frecuencia con la que se desencadena la paginación en segundos.
Comprobaciones por página	checksPerPage	number	Número de comprobaciones mostradas por página.
Use y (operador)	useTagsAndOperator	boolean	Cuándo usar el operador AND para la búsqueda de etiquetas.
Ocultar etiquetas	hideTags	boolean	Mostrar u ocultar las etiquetas en el panel.
Lista de etiquetas del panel	tags	DashboardTagList	Lista de una o varias etiquetas que filtran qué comprobaciones se muestran en el panel.
Id. del panel	dashboardId	string	Identificador del panel.

DashboardsList

Nombre	Ruta de acceso	Tipo	Description
Productos		Dashboard

Ubicación

Nombre	Ruta de acceso	Tipo	Description
Región	region	string	Identificador único de esta ubicación.
Nombre	name	string	Nombre descriptivo de esta ubicación.

LocationList

Nombre	Ruta de acceso	Tipo	Description
Productos		Location

MaintenanceWindowTagList

Los nombres de la ventana de comprobación y de mantenimiento de grupos deben aplicarse.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

MaintenanceWindow

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador de la ventana de mantenimiento.
Nombre	name	string	Nombre de la ventana de mantenimiento.
Lista de etiquetas de ventana de mantenimiento	tags	MaintenanceWindowTagList	Los nombres de la ventana de comprobación y de mantenimiento de grupos deben aplicarse.
Comienza en	startsAt	date	Fecha de inicio de la ventana de mantenimiento.
Termina en	endsAt	date	Fecha de finalización de la ventana de mantenimiento.
Intervalo de repetición	repeatInterval	number	Intervalo de repetición de la ventana de mantenimiento desde la primera aparición.
Repetir unidad	repeatUnit	string	Estrategia de repetición para la ventana de mantenimiento.
Finalizar de repetición en	repeatEndsAt	date	Fecha de finalización en la que la ventana de mantenimiento debe dejar de repetirse.
Creado en	created_at	date	Fecha de creación de la ventana de mantenimiento.
Actualizado en	updated_at	date	La última fecha en que se actualizó la ventana de mantenimiento.

MaintenanceWindowList

Lista de ventanas de mantenimiento.

Nombre	Ruta de acceso	Tipo	Description
Productos		MaintenanceWindow

CheckAssignment

Nombre	Ruta de acceso	Tipo	Description
identificación	id	guid	Identificador.
Comprobar id.	checkId	guid	Identificador de la comprobación.
Identificador de ubicación privada	privateLocationId	guid	Identificador de la ubicación privada asignada.

checkAssignments

Compruebe que se ha asignado esta ubicación privada.

Nombre	Ruta de acceso	Tipo	Description
Productos		CheckAssignment

GroupAssignment

Nombre	Ruta de acceso	Tipo	Description
identificación	id	guid	Identificador.
Identificador de grupo	groupId	number	Identificador del grupo.
Identificador de ubicación privada	privateLocationId	guid	Identificador de la ubicación privada asignada.

groupAssignments

El grupo a la que se ha asignado esta ubicación privada.

Nombre	Ruta de acceso	Tipo	Description
Productos		GroupAssignment

privateLocationKeys

Nombre	Ruta de acceso	Tipo	Description
identificación	id	guid	Identificador.
Clave sin formato	rawKey	string	Tecla sin formato.
Clave enmascarada	maskedKey	string	Valor de clave enmascarada.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date	Cuando se actualiza en .

keys

Nombre	Ruta de acceso	Tipo	Description
Productos		privateLocationKeys

privatelocationschema

Nombre	Ruta de acceso	Tipo	Description
identificación	id	guid	Identificador.
Nombre	name	string	Nombre asignado a la ubicación privada.
Nombre de slug	slugName	string	Nombre de slug válido.
Icon	icon	string	Icono de ubicación privada.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date	Cuando se actualiza en .
Comprobar asignaciones	checkAssignments	checkAssignments	Compruebe que se ha asignado esta ubicación privada.
Asignaciones de grupo	groupAssignments	groupAssignments	El grupo a la que se ha asignado esta ubicación privada.
keys	keys	keys
Última vista	lastSeen	date	La última fecha vista.
Recuento de agentes	agentCount	number	Recuento de agentes.

privateLocationsListSchema

Nombre	Ruta de acceso	Tipo	Description
Productos		privatelocationschema

commonPrivateLocationSchemaResponse

Nombre	Ruta de acceso	Tipo	Description
identificación	id	guid	Identificador.
Nombre	name	string	Nombre asignado a la ubicación privada.
Nombre de slug	slugName	string	Nombre de slug válido.
Icon	icon	string	Icono de ubicación privada.
Creado en	created_at	date	Cuando se crea en .
Actualizado en	updated_at	date	Cuando se actualiza en .
Comprobar asignaciones	checkAssignments	checkAssignments	Compruebe que se ha asignado esta ubicación privada.
Asignaciones de grupo	groupAssignments	groupAssignments	El grupo a la que se ha asignado esta ubicación privada.
keys	keys	keys

marcas de tiempo

Nombre	Ruta de acceso	Tipo	Description
Marca de tiempo		date-time	Marca de tiempo.

queueSize

Tamaño de la cola.

Nombre	Ruta de acceso	Tipo	Description
Productos		number

oldestScheduledCheckRun

Nombre	Ruta de acceso	Tipo	Description
Productos		number

privateLocationsMetricsHistoryResponseSchema

Nombre	Ruta de acceso	Tipo	Description
marcas de tiempo	timestamps	timestamps
Tamaño de cola	queueSize	queueSize	Tamaño de la cola.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Compruebe las etiquetas.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

ReportingAggregate

Nombre	Ruta de acceso	Tipo	Description
Relación de éxito	successRatio	number	Proporción correcta de la comprobación sobre el intervalo de fechas seleccionado. El porcentaje está en forma decimal.
Average	avg	number	Tiempo medio de respuesta de la comprobación durante el intervalo de fechas seleccionado en milisegundos.
P95	p95	number	Tiempo de respuesta P95 del intervalo de fechas seleccionado en milisegundos.
P99	p99	number	Tiempo de respuesta P99 del intervalo de fechas seleccionado en milisegundos.

Generación de informes

Nombre	Ruta de acceso	Tipo	Description
Nombre	name	string	Compruebe el nombre.
Comprobar id.	checkId	string	Compruebe el identificador.
Comprobar tipo	checkType	string	Compruebe el tipo.
Desactivado	deactivated	boolean	Active la casilla desactivada.
Lista de etiquetas de informes	tags	ReportingTagList	Compruebe las etiquetas.
agregado	aggregate	ReportingAggregate

ReportingList

Nombre	Ruta de acceso	Tipo	Description
Productos		Reporting

Tiempo de ejecución

Nombre	Ruta de acceso	Tipo	Description
Nombre	name	string	Nombre único de este runtime.
Etapa	stage	string	Fase de vida actual de un entorno de ejecución.
Finalización del ciclo de vida en tiempo de ejecución	runtimeEndOfLife	string	Fecha en la que se quitará un entorno de ejecución de nuestra plataforma.
Predeterminado	default	boolean	Indica si se trata del tiempo de ejecución predeterminado actual proporcionado por Checkly.
Description	description	string	Una breve descripción legible de las principales actualizaciones de este entorno de ejecución.
String	dependencies.string	string	Cadena.

RuntimeList

Nombre	Ruta de acceso	Tipo	Description
Productos		Runtime

Fragmento

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Nombre	name	string	Nombre del fragmento de código.
Script	script	string	El código de Node.js que interactúa con el ciclo de vida de la comprobación de API o funciona como parcial para las comprobaciones del explorador.
Creado en	created_at	date-time	Cuando se crea en .
Actualizado en	updated_at	date-time	Cuando se actualiza en .

SnippetList

Nombre	Ruta de acceso	Tipo	Description
Productos		Snippet

CheckGroupTrigger

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Token	token	string	El token.
Creado en	created_at	date	Cuando se crea en .
Llamada a en	called_at	date	Cuando se llama a .
Actualizado en	updated_at	date	Cuando se actualiza en .
Identificador de grupo	groupId	number	Identificador de grupo.

CheckTrigger

Nombre	Ruta de acceso	Tipo	Description
identificación	id	number	Identificador.
Token	token	string	El token.
Creado en	created_at	date	Cuando se crea en .
Llamada a en	called_at	date	Cuando se llama a .
Actualizado en	updated_at	date	Cuando se actualiza en .
Comprobar id.	checkId	string	Identificador de comprobación.

objeto

Este es el tipo 'object'.

cuerda / cadena

Este es el tipo de datos básico "string".

Compartir a través de

Checkly (Publicador independiente) (versión preliminar)

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Actualización de las suscripciones de un canal de alerta

Parámetros

Devoluciones

Actualización de un canal de alerta

Parámetros

Devoluciones

Actualización de un panel

Parámetros

Devoluciones

Actualización de una comprobación de API

Parámetros

Devoluciones

Actualización de una comprobación del explorador

Parámetros

Devoluciones

Actualización de una ubicación privada

Parámetros

Devoluciones

Actualización de una variable de entorno

Parámetros

Devoluciones

Actualizar un fragmento de código

Parámetros

Devoluciones

Actualizar un grupo de comprobación

Parámetros

Devoluciones

Actualizar una comprobación [EN DESUSO]

Parámetros

Devoluciones

Actualizar una ventana de mantenimiento

Parámetros

Devoluciones

Creación de un canal de alerta

Parámetros

Devoluciones

Creación de un fragmento de código

Parámetros

Devoluciones

Creación de un grupo de comprobación

Parámetros

Devoluciones

Creación de una comprobación de API

Parámetros

Devoluciones

Creación de una comprobación del explorador

Parámetros

Devoluciones

Creación de una ubicación privada

Parámetros

Devoluciones

Creación de una variable de entorno

Parámetros

Devoluciones

Creación de una ventana de mantenimiento

Parámetros

Devoluciones

Creación del desencadenador check

Parámetros

Devoluciones

Creación del desencadenador de grupo de comprobación

Parámetros

Devoluciones

Crear un tablero de control

Parámetros

Devoluciones

Crear una comprobación [EN DESUSO]

Parámetros

Devoluciones

Eliminación de un canal de alerta

Parámetros

Eliminación de una clave de API existente para una ubicación privada

Parámetros

Eliminación de una variable de entorno