Integration

/v1-Routenreferenz

Liste aus dem OpenAPI-Vertrag beim Rendern — entfernte Routen verschwinden von selbst.

OpenAPI-Vertrag API-Schlüssel ausstellen Kostenloses Solo-Konto

Vollständiges Dokument, ohne Authentifizierung, bereit für Ihren Client-Generator.

Endpunkte

Beim Rendern aus dem Vertrag gelesen: Sie kann keinen Endpunkt beschreiben, den es nicht mehr gibt.

Zusammenfassungen, Beschreibungen und Grenzen stammen aus dem OpenAPI-Vertrag, der in der Sprache dieser Seite ausgeliefert wird. Pfade, Typen und Geltungsbereiche sind in allen Sprachen identisch.

30 / 30

scenarios

GET/v1/scenariosSzenarien auflistenscenarios:read

Der Ablauf eines Browser-Szenarios wird nicht zurückgegeben — er enthält Zugangsdaten. `scenarioFingerprint` ändert sich, sobald er geändert wird, was zur Erkennung einer Abweichung genügt.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`limit`	`query`	`integer`	`1–500`	`100`	Seitengröße, standardmäßig 100.
`cursor`	`query`	`string`	—	—	Wert `nextCursor` aus der vorigen Antwort. Auf der letzten Seite nicht vorhanden.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

POST/v1/scenariosSzenario erstellenscenarios:writewiederholbar

`type: http` verlangt `url` oder `httpChain`. `type: browser` verlangt `scenario`. `enabled: false` legt ein Szenario an, ohne Alarm auszulösen. Mit `Idempotency-Key` wiederholbar.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Gibt 24 Stunden lang dieselbe Antwort zurück, statt ein Duplikat zu erzeugen. In einer Pipeline, die erneut versuchen kann, unerlässlich.

Anfragerumpf

Name	Typ	Grenzen	Standard	Beschreibung
`name`*	`string`	`≤ 120 car.`	—
`type`	`"http" \| "browser"`	—	`"http"`
`url`	`string <uri>`	—	—	Für eine HTTP-Prüfung erforderlich.
`intervalSec`*	`integer`	`0–2592000`	—	0 = keine Planung.
`method`	`"GET" \| "HEAD"`	—	`"GET"`
`expectedStatus`	`integer`	`100–599`	—
`maxLatencyMs`	`integer`	`100–600000`	—
`expectText`	`string`	`≤ 500 car.`	—
`regions`	`array<string>`	`≤ 8 élém.`	—
`scenario`	`object`	—	—	Ablaufbaum: Liste von Schritten (`goto`, `click`, `fill`, `assert_text` …) und, für eine HTTP-Kette, `httpChain`. Siehe die Szenario-Dokumentation.
`tags`	`array<string>`	`≤ 10 élém.`	—
`folder`	`string`	`≤ 60 car.`	—
`severity`	`"critical" \| "major" \| "minor"`	—	—
`runbook`	`string`	`≤ 2000 car.`	—
`cron`	`string`	`≤ 120 car.`	—	5 Felder, z. B. `0 9 * * 1-5`.
`enabled`	`boolean`	—	—
`httpChain`	`array<object>`	—	—

Antworten

Code	Beschreibung
`201`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`409`	`Idempotency-Key` bereits mit anderem Rumpf verwendet.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}Szenario lesenscenarios:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

PATCH/v1/scenarios/{id}Szenario ändernscenarios:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Anfragerumpf

Optionaler Rumpf: nur die übermittelten Felder werden geändert.

Name	Typ	Grenzen	Standard	Beschreibung
`name`	`string`	`≤ 120 car.`	—
`url`	`string <uri>`	—	—	Nur HTTP-Prüfung.
`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`	—	—	Ablaufbaum: Liste von Schritten (`goto`, `click`, `fill`, `assert_text` …) und, für eine HTTP-Kette, `httpChain`. Siehe die Szenario-Dokumentation.
`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>`	—	—

Antworten

Code	Beschreibung
`200`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}Szenario löschenscenarios:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

POST/v1/scenarios/{id}/muteSzenario stummschaltenscenarios:write

`mutedUntil: null` weckt das Szenario wieder. Die Frist ist auf 30 Tage begrenzt.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Anfragerumpf

Name	Typ	Grenzen	Standard	Beschreibung
`mutedUntil`*	`string <date-time>`	—	—

Antworten

Code	Beschreibung
`200`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}/baselineVergleichsreferenz auf die letzte erfolgreiche Ausführung setzenscenarios:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}/runAusführung auslösenruns:trigger

Stellt eine Ausführung in die Warteschlange und gibt deren `jobId` zurück. Verbraucht Kontingent: Geltungsbereich `runs:trigger`.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

GET/v1/runsAusführungen auflistenruns:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`scenarioId`	`query`	`string <uuid>`	—	—	Filtert auf ein Szenario.
`limit`	`query`	`integer`	`1–500`	`100`	Seitengröße, standardmäßig 100.
`cursor`	`query`	`string`	—	—	Wert `nextCursor` aus der vorigen Antwort. Auf der letzten Seite nicht vorhanden.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

GET/v1/runs/{id}Ausführung und ihr Ergebnis lesenruns:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

incidents

GET/v1/incidentsVorfälle auflistenincidents:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`limit`	`query`	`integer`	`1–500`	`100`	Seitengröße, standardmäßig 100.
`cursor`	`query`	`string`	—	—	Wert `nextCursor` aus der vorigen Antwort. Auf der letzten Seite nicht vorhanden.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

PATCH/v1/incidents/{id}Vorfall schließen oder seinen Bericht veröffentlichenincidents:write

Das Wiedereröffnen eines Vorfalls löscht sein Lösungsdatum. `publicPostmortem` veröffentlicht den Bericht auf der Statusseite: nur für einen geprüften Text verwenden.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Anfragerumpf

Optionaler Rumpf: nur die übermittelten Felder werden geändert.

Name	Typ	Grenzen	Standard
`status`	`"open" \| "resolved"`	—	—
`postmortem`	`string`	`≤ 20000 car.`	—
`publicPostmortem`	`boolean`	—	—

Antworten

Code	Beschreibung
`200`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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/webhooksAusgehende Webhooks auflistenalerting:read
Die gespeicherte URL wird niemals zurückgegeben: sie ist im Ruhezustand verschlüsselt. `urlFingerprint` ändert sich, wenn sich das Ziel ändert, was zur Erkennung einer Abweichung genügt.
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/webhooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

POST/v1/webhooksAusgehenden Webhook erstellenalerting:writewiederholbar

Gibt das Signaturgeheimnis nur einmal bei der Erstellung zurück. Es werden nur öffentliche https-URLs akzeptiert.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Gibt 24 Stunden lang dieselbe Antwort zurück, statt ein Duplikat zu erzeugen. In einer Pipeline, die erneut versuchen kann, unerlässlich.

Anfragerumpf

Name	Typ	Grenzen	Standard	Beschreibung
`url`*	`string <uri>`	`≤ 500 car.`	—
`events`	`array<"run.failed" \| "run.recovered">`	`≥ 1 élém.`	—

Antworten

Code	Beschreibung
`201`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`409`	`Idempotency-Key` bereits mit anderem Rumpf verwendet.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}Ausgehenden Webhook lesenalerting:read

Abonnierte Ereignisse, Zustand und Fingerabdruck des Ziels. Die URL bleibt verschlüsselt.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

DELETE/v1/webhooks/{id}Ausgehenden Webhook löschenalerting:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

maintenance

GET/v1/maintenance-windowsWartungsfenster auflistenmaintenance:read
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

POST/v1/maintenance-windowsWartungsfenster erstellenmaintenance:writewiederholbar

Zwei Formen: einmalig (`startsAt` und `endsAt`) oder wöchentlich (`weekday`, `startMinute`, `durationMin`).

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Gibt 24 Stunden lang dieselbe Antwort zurück, statt ein Duplikat zu erzeugen. In einer Pipeline, die erneut versuchen kann, unerlässlich.

Anfragerumpf

Name	Typ	Grenzen	Standard	Beschreibung
`monitorId`	`string <uuid>`	—	—	Fehlt = die ganze Organisation.
`startsAt`	`string <date-time>`	—	—	Einmaliges Fenster.
`endsAt`	`string <date-time>`	—	—	Einmaliges Fenster, höchstens 90 Tage.
`reason`	`string`	`≤ 500 car.`	—
`weekday`	`integer`	`1–7`	—	Wöchentliches Fenster, 1 = Montag.
`startMinute`	`integer`	`0–1439`	—
`durationMin`	`integer`	`15–1440`	—

Antworten

Code	Beschreibung
`201`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`409`	`Idempotency-Key` bereits mit anderem Rumpf verwendet.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}Wartungsfenster lesenmaintenance:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

DELETE/v1/maintenance-windows/{id}Wartungsfenster löschenmaintenance:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

sla

GET/v1/slaMessung der Verfügbarkeitszielesla:read
Gemessene Rate und verbleibendes Fehlerbudget je Ziel.
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/sla" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```
GET/v1/sla-targetsKonfiguration der Ziele auflistensla:read
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/sla-targets" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

PUT/v1/sla-targetsZiel erstellen oder ersetzensla:writewiederholbar

Ein Ziel je Szenario, zusätzlich ein globales Ziel ohne `monitorId`. Ein erneuter Aufruf auf dasselbe Ziel ersetzt das bestehende Ziel.

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`Idempotency-Key`	`header`	`string`	`8–128 car., /^[A-Za-z0-9._:-]+$/`	—	Gibt 24 Stunden lang dieselbe Antwort zurück, statt ein Duplikat zu erzeugen. In einer Pipeline, die erneut versuchen kann, unerlässlich.

Anfragerumpf

Name	Typ	Grenzen	Standard
`monitorId`	`string <uuid>`	—	—
`name`	`string`	`≤ 120 car.`	—
`objectivePct`*	`number`	`50–100`	—
`windowDays`*	`integer`	`1–365`	—
`excludeMaintenance`	`boolean`	—	—
`warnAtBudgetRatio`	`number`	`0.1–1`	—
`enabled`	`boolean`	—	—

Antworten

Code	Beschreibung
`200`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`409`	`Idempotency-Key` bereits mit anderem Rumpf verwendet.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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}Ziel lesensla:read

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

DELETE/v1/sla-targets/{id}Ziel löschensla:write

Parameter

Name	Wo	Typ	Grenzen	Standard	Beschreibung
`id`*	`path`	`string <uuid>`	—	—	Kennung.

Antworten

Code	Beschreibung
`200`	Erfolg.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`404`	Ressource in dieser Organisation nicht gefunden.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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

org

GET/v1/settingsEinstellungen der Organisation lesenorg:read
Integrationsgeheimnisse verlassen das System nie: sie erscheinen als `has*`-Booleans.
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

PATCH/v1/settingsEinstellungen der Organisation ändernorg:write

Eine Teilmenge ohne Geheimnisse. Slack, Teams, Discord, PagerDuty, Opsgenie, Datadog und Sentry bleiben dem Back-Office vorbehalten, damit kein Geheimnis in eine Infrastrukturdatei geschrieben wird.

Parameter

Keine Parameter.

Anfragerumpf

Optionaler Rumpf: nur die übermittelten Felder werden geändert.

Name	Typ	Grenzen	Standard
`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`	—

Antworten

Code	Beschreibung
`200`	Erfolg.
`400`	Ungültiger Rumpf oder Parameter.
`401`	API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
`403`	Der Schlüssel trägt nicht den verlangten Geltungsbereich.
`429`	Zu viele Aufrufe für diesen Schlüssel.

Beispielaufruf

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/usageVerbrauch des Zeitraumsorg:read
Genug, um eine Pipeline zu stoppen, bevor das Kontingent erschöpft ist.
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/usage" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```
GET/v1/status/componentsKomponenten der öffentlichen Statusseiteorg:read
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/status/components" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```

members

GET/v1/membersMitglieder der Organisation auflistenmembers:read
Name, Adresse und Rolle der zugeordneten Konten, um einen Vorfall der zuständigen Person zuzuordnen. Keine Einladung und keine Änderung per API-Schlüssel.
Parameter
Keine Parameter.
Antworten
Code Beschreibung
200 Erfolg.
401 API-Schlüssel fehlt, unbekannt, widerrufen oder abgelaufen.
403 Der Schlüssel trägt nicht den verlangten Geltungsbereich.
429 Zu viele Aufrufe für diesen Schlüssel.
Beispielaufruf
```
curl "https://api.pathlyhq.com/v1/members" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
```