Documentation développeurs

Modèle mental

Pathly expose une API publique versionnée sous https://api.pathlyhq.com/v1. Une organisation possède des scénarios, des runs, des incidents, des webhooks, des fenêtres de maintenance et des objectifs de disponibilité. La console et l’API partagent la même vérité de configuration : ce que vous créez ici apparaît là, et inversement.

Deux portes, une stack : le métier enregistre un Flow dans la console ; le tech versionne Ping, Chain, webhooks et SLA via IaC ou SDK. Une Chain se crée avec `httpChain` sur POST /v1/scenarios (hops login → API). Les secrets d’un Flow ne doivent jamais entrer dans un état Terraform ni un dépôt Git.

Le contrat OpenAPI servi par la plateforme est la source de vérité des routes. Cette page le lit au rendu : une route retirée disparaît d’elle-même de la référence ci-dessous.

Quickstart 5 minutes

Objectif : une clé, un Ping, un webhook de test, un lien Terraform. Comptez cinq minutes si le compte Solo existe déjà. Une Chain se pose ensuite avec httpChain (API) ou http_chain (provider).

1) Allez sur la Console Pathly (créez un compte gratuit via le lien ci-dessous) → Réglages → Clés d’API → émettre une clé avec scenarios:write et alerting:write. Copier le secret une seule fois (préfixe sp_). 2) Exporter PATHLY_API_TOKEN. 3) Créer le scénario (exemple ci-dessous). 4) Créer un webhook vers un récepteur de test (webhook.site ou votre /hooks). 5) Provider Terraform pathlyhq/pathly pour versionner la suite.

• Créer un compte gratuit → obtenir une clé 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

Pages de la doc

À écrire (backlog SEO)

Intentions de pages pas encore créées. Passer une entrée en status live + sectionIds suffit pour l’ouvrir.

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

  Landing SEO « monitoring as code » / alternative Checkly — prévu aussi en /cas-usage/.