Integración

Referencia de rutas /v1

Lista leída del contrato OpenAPI al renderizar.

Contrato OpenAPI Emitir una clave de API Cuenta Solo gratis

Documento completo, sin autenticación, listo para su generador de clientes.

Rutas

Leída del contrato en el momento del renderizado: no puede describir una ruta que ya no existe.

Resúmenes, descripciones y límites provienen del contrato OpenAPI, servido en el idioma de esta página. Rutas, tipos y alcances son idénticos en todos los idiomas.

30 / 30

scenarios

GET/v1/scenariosListar los escenariosscenarios:read

El recorrido de un escenario de navegador no se devuelve: contiene credenciales de acceso. `scenarioFingerprint` cambia en cuanto se modifica, lo que basta para detectar una desviación.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`limit`	`query`	`integer`	`1–500`	`100`	Tamaño de página, 100 por defecto.
`cursor`	`query`	`string`	—	—	Valor `nextCursor` de la respuesta anterior. Ausente en la última página.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/scenarios?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

POST/v1/scenariosCrear un escenarioscenarios:writerepetible

`type: http` exige `url` o `httpChain`. `type: browser` exige `scenario`. `enabled: false` prepara un escenario sin disparar ninguna alerta. Repetible con `Idempotency-Key`.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Reproduce la misma respuesta durante 24 horas en lugar de crear un duplicado. Imprescindible en una canalización que puede reintentar.

Cuerpo de la petición

Nombre	Tipo	Límites	Por defecto	Descripción
`name`*	`string`	`≤ 120 car.`	—
`type`	`"http" \| "browser"`	—	`"http"`
`url`	`string <uri>`	—	—	Obligatoria para un control HTTP.
`intervalSec`*	`integer`	`0–2592000`	—	0 = sin planificación.
`method`	`"GET" \| "HEAD"`	—	`"GET"`
`expectedStatus`	`integer`	`100–599`	—
`maxLatencyMs`	`integer`	`100–600000`	—
`expectText`	`string`	`≤ 500 car.`	—
`regions`	`array<string>`	`≤ 8 élém.`	—
`scenario`	`object`	—	—	Árbol del recorrido: lista de pasos (`goto`, `click`, `fill`, `assert_text`…) y, para una cadena HTTP, `httpChain`. Véase la documentación de escenarios.
`tags`	`array<string>`	`≤ 10 élém.`	—
`folder`	`string`	`≤ 60 car.`	—
`severity`	`"critical" \| "major" \| "minor"`	—	—
`runbook`	`string`	`≤ 2000 car.`	—
`cron`	`string`	`≤ 120 car.`	—	5 campos, p. ej. `0 9 * * 1-5`.
`enabled`	`boolean`	—	—
`httpChain`	`array<object>`	—	—

Respuestas

Código	Descripción
`201`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`409`	`Idempotency-Key` ya utilizada con otro cuerpo.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/scenarios" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"type":"http","name":"Page d'\''accueil","url":"https://www.example.com","intervalSec":300,"expectedStatus":200,"maxLatencyMs":2000,"severity":"major","tags":["prod"]}'

GET/v1/scenarios/{id}Leer un escenarioscenarios:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

PATCH/v1/scenarios/{id}Modificar un escenarioscenarios:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Cuerpo de la petición

Cuerpo opcional: solo se modifican los campos enviados.

Nombre	Tipo	Límites	Por defecto	Descripción
`name`	`string`	`≤ 120 car.`	—
`url`	`string <uri>`	—	—	Solo control HTTP.
`intervalSec`	`integer`	`0–2592000`	—
`method`	`"GET" \| "HEAD"`	—	—
`expectedStatus`	`integer`	`100–599`	—
`maxLatencyMs`	`integer`	`100–600000`	—
`enabled`	`boolean`	—	—
`expectText`	`string`	`≤ 500 car.`	—
`regions`	`array<string>`	`≤ 8 élém.`	—
`scenario`	`object`	—	—	Árbol del recorrido: lista de pasos (`goto`, `click`, `fill`, `assert_text`…) y, para una cadena HTTP, `httpChain`. Véase la documentación de escenarios.
`tags`	`array<string>`	`≤ 10 élém.`	—
`folder`	`string`	`≤ 60 car.`	—
`severity`	`"critical" \| "major" \| "minor"`	—	—
`runbook`	`string`	`≤ 2000 car.`	—
`cron`	`string`	`≤ 120 car.`	—
`httpChain`	`array<object>`	—	—

Respuestas

Código	Descripción
`200`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X PATCH "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"intervalSec":600,"maxLatencyMs":3000,"severity":"critical"}'

DELETE/v1/scenarios/{id}Eliminar un escenarioscenarios:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X DELETE "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

POST/v1/scenarios/{id}/muteSilenciar un escenarioscenarios:write

`mutedUntil: null` reactiva el escenario. El vencimiento se limita a 30 días.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Cuerpo de la petición

Nombre	Tipo	Límites	Por defecto	Descripción
`mutedUntil`*	`string <date-time>`	—	—

Respuestas

Código	Descripción
`200`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90/mute" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mutedUntil":"2026-10-01T06:00:00.000Z"}'

POST/v1/scenarios/{id}/baselineFijar la referencia de comparación en la última ejecución correctascenarios:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90/baseline" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

runs

POST/v1/scenarios/{id}/runLanzar una ejecuciónruns:trigger

Encola una ejecución y devuelve su `jobId`. Consume cuota: alcance `runs:trigger`.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90/run" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

GET/v1/runsListar las ejecucionesruns:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`scenarioId`	`query`	`string <uuid>`	—	—	Filtra un escenario.
`limit`	`query`	`integer`	`1–500`	`100`	Tamaño de página, 100 por defecto.
`cursor`	`query`	`string`	—	—	Valor `nextCursor` de la respuesta anterior. Ausente en la última página.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/runs?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

GET/v1/runs/{id}Leer una ejecución y su veredictoruns:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/runs/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

incidents

GET/v1/incidentsListar los incidentesincidents:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`limit`	`query`	`integer`	`1–500`	`100`	Tamaño de página, 100 por defecto.
`cursor`	`query`	`string`	—	—	Valor `nextCursor` de la respuesta anterior. Ausente en la última página.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/incidents?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

PATCH/v1/incidents/{id}Cerrar un incidente o publicar su informeincidents:write

Reabrir un incidente borra su fecha de resolución. `publicPostmortem` publica el informe en la página de estado: resérvelo para un texto revisado.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Cuerpo de la petición

Cuerpo opcional: solo se modifican los campos enviados.

Nombre	Tipo	Límites	Por defecto
`status`	`"open" \| "resolved"`	—	—
`postmortem`	`string`	`≤ 20000 car.`	—
`publicPostmortem`	`boolean`	—	—

Respuestas

Código	Descripción
`200`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X PATCH "https://api.pathlyhq.com/v1/incidents/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"resolved","postmortem":"Certificat renouvelé, le contrôle repasse au vert.","publicPostmortem":false}'

alerting

GET/v1/webhooksListar los webhooks salientesalerting:read
La URL registrada nunca se devuelve: está cifrada en reposo. `urlFingerprint` cambia si el destino cambia, lo que basta para detectar una desviación.
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/webhooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

POST/v1/webhooksCrear un webhook salientealerting:writerepetible

Devuelve el secreto de firma una sola vez, al crearlo. Solo se aceptan URL públicas https.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Reproduce la misma respuesta durante 24 horas en lugar de crear un duplicado. Imprescindible en una canalización que puede reintentar.

Cuerpo de la petición

Nombre	Tipo	Límites	Por defecto	Descripción
`url`*	`string <uri>`	`≤ 500 car.`	—
`events`	`array<"run.failed" \| "run.recovered">`	`≥ 1 élém.`	—

Respuestas

Código	Descripción
`201`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`409`	`Idempotency-Key` ya utilizada con otro cuerpo.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/webhooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.example.com/hooks/pathly","events":["run.failed","run.recovered"]}'

GET/v1/webhooks/{id}Leer un webhook salientealerting:read

Eventos escuchados, estado y huella del destino. La URL permanece cifrada.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/webhooks/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

DELETE/v1/webhooks/{id}Eliminar un webhook salientealerting:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X DELETE "https://api.pathlyhq.com/v1/webhooks/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

maintenance

GET/v1/maintenance-windowsListar las ventanas de mantenimientomaintenance:read
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

POST/v1/maintenance-windowsCrear una ventana de mantenimientomaintenance:writerepetible

Dos formas: puntual (`startsAt` y `endsAt`) o semanal (`weekday`, `startMinute`, `durationMin`).

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Reproduce la misma respuesta durante 24 horas en lugar de crear un duplicado. Imprescindible en una canalización que puede reintentar.

Cuerpo de la petición

Nombre	Tipo	Límites	Por defecto	Descripción
`monitorId`	`string <uuid>`	—	—	Ausente = toda la organización.
`startsAt`	`string <date-time>`	—	—	Ventana puntual.
`endsAt`	`string <date-time>`	—	—	Ventana puntual, 90 días como máximo.
`reason`	`string`	`≤ 500 car.`	—
`weekday`	`integer`	`1–7`	—	Ventana semanal, 1 = lunes.
`startMinute`	`integer`	`0–1439`	—
`durationMin`	`integer`	`15–1440`	—

Respuestas

Código	Descripción
`201`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`409`	`Idempotency-Key` ya utilizada con otro cuerpo.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X POST "https://api.pathlyhq.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"startsAt":"2026-10-04T01:00:00.000Z","endsAt":"2026-10-04T03:00:00.000Z","reason":"Migration de base"}'

GET/v1/maintenance-windows/{id}Leer una ventana de mantenimientomaintenance:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/maintenance-windows/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

DELETE/v1/maintenance-windows/{id}Eliminar una ventana de mantenimientomaintenance:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X DELETE "https://api.pathlyhq.com/v1/maintenance-windows/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

sla

GET/v1/slaMedición de los objetivos de disponibilidadsla:read
Tasa medida y presupuesto de error restante, por objetivo.
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/sla" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```
GET/v1/sla-targetsListar la configuración de los objetivossla:read
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/sla-targets" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

PUT/v1/sla-targetsCrear o reemplazar un objetivosla:writerepetible

Un objetivo por escenario, más un objetivo global sin `monitorId`. Volver a llamar con el mismo destino reemplaza el objetivo existente.

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Reproduce la misma respuesta durante 24 horas en lugar de crear un duplicado. Imprescindible en una canalización que puede reintentar.

Cuerpo de la petición

Nombre	Tipo	Límites	Por defecto
`monitorId`	`string <uuid>`	—	—
`name`	`string`	`≤ 120 car.`	—
`objectivePct`*	`number`	`50–100`	—
`windowDays`*	`integer`	`1–365`	—
`excludeMaintenance`	`boolean`	—	—
`warnAtBudgetRatio`	`number`	`0.1–1`	—
`enabled`	`boolean`	—	—

Respuestas

Código	Descripción
`200`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`409`	`Idempotency-Key` ya utilizada con otro cuerpo.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X PUT "https://api.pathlyhq.com/v1/sla-targets" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"name":"Disponibilité globale","objectivePct":99.9,"windowDays":30,"excludeMaintenance":true}'

GET/v1/sla-targets/{id}Leer un objetivosla:read

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl "https://api.pathlyhq.com/v1/sla-targets/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

DELETE/v1/sla-targets/{id}Eliminar un objetivosla:write

Parámetros

Nombre	Dónde	Tipo	Límites	Por defecto	Descripción
`id`*	`path`	`string <uuid>`	—	—	Identificador.

Respuestas

Código	Descripción
`200`	Éxito.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`404`	Recurso no encontrado en esta organización.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X DELETE "https://api.pathlyhq.com/v1/sla-targets/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

org

GET/v1/settingsLeer los ajustes de la organizaciónorg:read
Los secretos de integración nunca salen: aparecen como booleanos `has*`.
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

PATCH/v1/settingsModificar los ajustes de la organizaciónorg:write

Un subconjunto sin secretos. Slack, Teams, Discord, PagerDuty, Opsgenie, Datadog y Sentry quedan reservados al back-office, para no escribir ningún secreto en un archivo de infraestructura.

Parámetros

Sin parámetros.

Cuerpo de la petición

Cuerpo opcional: solo se modifican los campos enviados.

Nombre	Tipo	Límites	Por defecto
`alertEmail`	`string <email>`	—	—
`alertOnRecovery`	`boolean`	—	—
`escalationAfterFails`	`integer`	`2–20`	—
`escalationEmail`	`string <email>`	—	—
`weeklyDigestEmail`	`string <email>`	—	—
`weeklyDigestEnabled`	`boolean`	—	—
`statusSlug`	`string`	`≤ 64 car.`	—
`statusPublic`	`boolean`	—	—
`timezone`	`string`	`≤ 64 car.`	—
`sslWarnDays`	`array<integer>`	`≤ 6 élém.`	—
`domainWarnDays`	`array<integer>`	`≤ 6 élém.`	—
`triageEnabled`	`boolean`	—	—
`triageConfirmEnabled`	`boolean`	—	—
`triageLatencyFactor`	`number`	`1.5–10`	—

Respuestas

Código	Descripción
`200`	Éxito.
`400`	Cuerpo o parámetro no válido.
`401`	Clave de API ausente, desconocida, revocada o caducada.
`403`	La clave no posee el alcance exigido.
`429`	Demasiadas llamadas para esta clave.

Ejemplo de llamada

curl -X PATCH "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alertEmail":"supervision@example.com","alertOnRecovery":true,"escalationAfterFails":3,"timezone":"Europe/Paris"}'

GET/v1/usageConsumo del períodoorg:read
Lo necesario para detener una canalización antes de agotar la cuota.
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/usage" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```
GET/v1/status/componentsComponentes de la página de estado públicaorg:read
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/status/components" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

members

GET/v1/membersListar los miembros de la organizaciónmembers:read
Nombre, dirección y función de las cuentas vinculadas, para asociar un incidente con su responsable. Ninguna invitación ni modificación mediante clave de API.
Parámetros
Sin parámetros.
Respuestas
Código Descripción
200 Éxito.
401 Clave de API ausente, desconocida, revocada o caducada.
403 La clave no posee el alcance exigido.
429 Demasiadas llamadas para esta clave.
Ejemplo de llamada
```
curl "https://api.pathlyhq.com/v1/members" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```