Entwicklerdokumentation

Mentales Modell

Pathly stellt eine versionierte öffentliche API unter https://api.pathlyhq.com/v1 bereit. Eine Organisation besitzt Szenarien, Runs, Vorfälle, Webhooks, Wartungsfenster und Verfügbarkeitsziele. Konsole und API teilen dieselbe Konfigurationswahrheit.

Zwei Türen, ein Stack: Fachseite zeichnet ein Flow in der Konsole auf; Tech versioniert Ping, Chain, Webhooks und SLAs per IaC oder SDK. Eine Chain entsteht mit `httpChain` auf POST /v1/scenarios. Flow-Geheimnisse gehören nie in Terraform-State oder Git.

Der von der Plattform gelieferte OpenAPI-Vertrag ist die Quelle der Wahrheit für Routen. Diese Seite lädt ihn beim Rendern.

5-Minuten-Quickstart

Ziel: ein Schlüssel, ein Ping, ein Test-Webhook, ein Terraform-Hinweis. Etwa fünf Minuten, wenn das Solo-Konto schon existiert. Eine Chain folgt mit httpChain (API) oder http_chain (Provider).

1) Öffnen Sie die Pathly-Konsole (kostenloses Konto über den Link unten) → Einstellungen → API-Schlüssel → mit scenarios:write und alerting:write ausstellen. Geheimnis einmal kopieren (Präfix sp_). 2) PATHLY_API_TOKEN exportieren. 3) Szenario anlegen. 4) Test-Webhook anlegen. 5) Terraform-Provider pathlyhq/pathly.

• Kostenloses Konto → API-Schlüssel holen

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

Doku-Seiten

Noch zu schreiben (SEO-Backlog)

Noch nicht angelegte Seiten-Intents. Auf status live + sectionIds setzen zum Veröffentlichen.

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

  SEO-Landing „monitoring as code“ / Checkly-Alternative.