Documentación para desarrolladores

Modelo mental

Pathly expone una API pública versionada bajo https://api.pathlyhq.com/v1. Una organización posee escenarios, runs, incidentes, webhooks, ventanas de mantenimiento y objetivos de disponibilidad. Consola y API comparten la misma verdad de configuración.

Dos puertas, un stack: el negocio graba un Flow en la consola; el tech versiona Ping, Chain, webhooks y SLA vía IaC o SDK. Una Chain se crea con `httpChain` en POST /v1/scenarios. Los secretos de un Flow no deben entrar en Terraform ni en Git.

El contrato OpenAPI que sirve la plataforma es la fuente de verdad de las rutas. Esta página lo lee al renderizar.

Quickstart 5 minutos

Objetivo: una clave, un Ping, un webhook de prueba, un enlace Terraform. Unos cinco minutos si la cuenta Solo ya existe. Una Chain se crea luego con httpChain (API) o http_chain (provider).

1) Abra la Consola Pathly (cree una cuenta gratis con el enlace de abajo) → Ajustes → Claves de API → emitir con scenarios:write y alerting:write. Copiar el secreto una vez (prefijo sp_). 2) Exportar PATHLY_API_TOKEN. 3) Crear el escenario. 4) Crear un webhook de prueba. 5) Provider Terraform pathlyhq/pathly.

• Crear cuenta gratis → obtener clave API

export PATHLY_API_TOKEN=sp_…

curl -sS https://api.pathlyhq.com/v1/scenarios \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" | jq .

curl -sS -X POST https://api.pathlyhq.com/v1/scenarios \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: qs-$(date +%Y%m%d)-home" \
  -d '{
    "type": "http",
    "name": "Home",
    "url": "https://www.example.com/",
    "intervalSec": 300,
    "expectedStatus": 200
  }'

curl -sS -X POST https://api.pathlyhq.com/v1/webhooks \
  -H "Authorization: Bearer $PATHLY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: qs-hook-1" \
  -d '{
    "url": "https://www.example.com/hooks/pathly",
    "events": ["run.failed", "run.recovered"]
  }'

terraform {
  required_providers {
    pathly = { source = "pathlyhq/pathly", version = "~> 0.1" }
  }
}
provider "pathly" {}
# PATHLY_API_TOKEN dans l'environnement CI / shell — jamais dans .tf

Páginas de la doc

Por escribir (backlog SEO)

Intenciones de página aún no creadas. Poner status live + sectionIds para publicarla.

• Monitoring as code — /developers/monitoring-as-code

  Landing SEO “monitoring as code” / alternativa Checkly.