PathlyEssayer Flow

Intégration

Référence des routes /v1

Liste lue dans le contrat OpenAPI au rendu — une route retirée disparaît d’elle-même.

Contrat OpenAPIÉmettre une clé d’APICompte Solo gratuit

Document complet, sans authentification, à donner à votre générateur de client.

Routes

Liste lue dans le contrat au moment du rendu : elle ne peut pas décrire une route qui n’existe plus.

Résumés, descriptions et bornes viennent du contrat OpenAPI, servi dans la langue de cette page. Chemins, types et portées sont identiques dans toutes les langues.

30 / 30

scenarios

  • GET/v1/scenariosLister les scénariosscenarios:read

    Le parcours d'un scénario navigateur n'est pas rendu — il porte des identifiants de connexion. `scenarioFingerprint` change dès qu'il est modifié, ce qui suffit à détecter une dérive.

    Paramètres

    NomOùTypeBornesDéfautDescription
    limitqueryinteger1–500100Taille de page, 100 par défaut.
    cursorquerystring——Valeur `nextCursor` de la réponse précédente. Absente de la dernière page.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/scenarios?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/scenariosCréer un scénarioscenarios:writerejouable

    `type: http` exige `url` ou `httpChain`. `type: browser` exige `scenario`. `enabled: false` prépare un scénario sans déclencher d'alerte. Rejouable avec `Idempotency-Key`.

    Paramètres

    NomOùTypeBornesDéfautDescription
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Rejoue la même réponse pendant 24 heures au lieu de créer un doublon. Indispensable dans un pipeline qui peut réessayer.

    Corps de la requête

    NomTypeBornesDéfautDescription
    name*string≤ 120 car.—
    type"http" | "browser"—"http"
    urlstring <uri>——Requise pour un contrôle HTTP.
    intervalSec*integer0–2592000—0 = pas de planification.
    method"GET" | "HEAD"—"GET"
    expectedStatusinteger100–599—
    maxLatencyMsinteger100–600000—
    expectTextstring≤ 500 car.—
    regionsarray<string>≤ 8 élém.—
    scenarioobject——Arbre du parcours : liste d'étapes (`goto`, `click`, `fill`, `assert_text`…) et, pour une chaîne HTTP, `httpChain`. Voir la documentation des scénarios.
    tagsarray<string>≤ 10 élém.—
    folderstring≤ 60 car.—
    severity"critical" | "major" | "minor"——
    runbookstring≤ 2000 car.—
    cronstring≤ 120 car.—5 champs, ex. `0 9 * * 1-5`.
    enabledboolean——
    httpChainarray<object>——

    Réponses

    CodeDescription
    201Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    409`Idempotency-Key` déjà utilisée avec un autre corps.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}Lire un scénarioscenarios:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/scenarios/{id}Modifier un scénarioscenarios:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Corps de la requête

    Corps facultatif : seuls les champs transmis sont modifiés.

    NomTypeBornesDéfautDescription
    namestring≤ 120 car.—
    urlstring <uri>——Contrôle HTTP seulement.
    intervalSecinteger0–2592000—
    method"GET" | "HEAD"——
    expectedStatusinteger100–599—
    maxLatencyMsinteger100–600000—
    enabledboolean——
    expectTextstring≤ 500 car.—
    regionsarray<string>≤ 8 élém.—
    scenarioobject——Arbre du parcours : liste d'étapes (`goto`, `click`, `fill`, `assert_text`…) et, pour une chaîne HTTP, `httpChain`. Voir la documentation des scénarios.
    tagsarray<string>≤ 10 élém.—
    folderstring≤ 60 car.—
    severity"critical" | "major" | "minor"——
    runbookstring≤ 2000 car.—
    cronstring≤ 120 car.—
    httpChainarray<object>——

    Réponses

    CodeDescription
    200Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}Supprimer un scénarioscenarios:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl -X DELETE "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/scenarios/{id}/muteMettre un scénario en sourdinescenarios:write

    `mutedUntil: null` réveille le scénario. Échéance plafonnée à 30 jours.

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Corps de la requête

    NomTypeBornesDéfautDescription
    mutedUntil*string <date-time>——

    Réponses

    CodeDescription
    200Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}/baselineFixer la référence de comparaison sur la dernière exécution réussiescenarios:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}/runDéclencher une exécutionruns:trigger

    Met une exécution en file et rend son `jobId`. Consomme du quota : portée `runs:trigger`.

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl -X POST "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90/run" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/runsLister les exécutionsruns:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    scenarioIdquerystring <uuid>——Filtre un scénario.
    limitqueryinteger1–500100Taille de page, 100 par défaut.
    cursorquerystring——Valeur `nextCursor` de la réponse précédente. Absente de la dernière page.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/runs?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/runs/{id}Lire une exécution et son verdictruns:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

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

incidents

  • GET/v1/incidentsLister les incidentsincidents:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    limitqueryinteger1–500100Taille de page, 100 par défaut.
    cursorquerystring——Valeur `nextCursor` de la réponse précédente. Absente de la dernière page.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/incidents?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/incidents/{id}Clôturer un incident ou publier son constatincidents:write

    Réouvrir un incident efface sa date de résolution. `publicPostmortem` publie le constat sur la page de statut : à réserver à un texte relu.

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Corps de la requête

    Corps facultatif : seuls les champs transmis sont modifiés.

    NomTypeBornesDéfautDescription
    status"open" | "resolved"——
    postmortemstring≤ 20000 car.—
    publicPostmortemboolean——

    Réponses

    CodeDescription
    200Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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/webhooksLister les webhooks sortantsalerting:read

    L'URL enregistrée n'est jamais renvoyée : elle est chiffrée au repos. `urlFingerprint` change si la destination change, ce qui suffit à détecter une dérive.

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/webhooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/webhooksCréer un webhook sortantalerting:writerejouable

    Rend le secret de signature une seule fois, à la création. Seules des URL publiques https sont acceptées.

    Paramètres

    NomOùTypeBornesDéfautDescription
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Rejoue la même réponse pendant 24 heures au lieu de créer un doublon. Indispensable dans un pipeline qui peut réessayer.

    Corps de la requête

    NomTypeBornesDéfautDescription
    url*string <uri>≤ 500 car.—
    eventsarray<"run.failed" | "run.recovered">≥ 1 élém.—

    Réponses

    CodeDescription
    201Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    409`Idempotency-Key` déjà utilisée avec un autre corps.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}Lire un webhook sortantalerting:read

    Événements écoutés, état, et empreinte de la destination. L'URL reste chiffrée.

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/webhooks/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • DELETE/v1/webhooks/{id}Supprimer un webhook sortantalerting:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

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

maintenance

  • GET/v1/maintenance-windowsLister les fenêtres de maintenancemaintenance:read

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/maintenance-windowsCréer une fenêtre de maintenancemaintenance:writerejouable

    Deux formes : ponctuelle (`startsAt` et `endsAt`) ou hebdomadaire (`weekday`, `startMinute`, `durationMin`).

    Paramètres

    NomOùTypeBornesDéfautDescription
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Rejoue la même réponse pendant 24 heures au lieu de créer un doublon. Indispensable dans un pipeline qui peut réessayer.

    Corps de la requête

    NomTypeBornesDéfautDescription
    monitorIdstring <uuid>——Absent = toute l'organisation.
    startsAtstring <date-time>——Fenêtre ponctuelle.
    endsAtstring <date-time>——Fenêtre ponctuelle, 90 jours maximum.
    reasonstring≤ 500 car.—
    weekdayinteger1–7—Fenêtre hebdomadaire, 1 = lundi.
    startMinuteinteger0–1439—
    durationMininteger15–1440—

    Réponses

    CodeDescription
    201Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    409`Idempotency-Key` déjà utilisée avec un autre corps.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}Lire une fenêtre de maintenancemaintenance:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/maintenance-windows/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • DELETE/v1/maintenance-windows/{id}Supprimer une fenêtre de maintenancemaintenance:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

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

sla

  • GET/v1/slaMesure des objectifs de disponibilitésla:read

    Taux mesuré et budget d'erreur restant, par objectif.

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/sla" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/sla-targetsLister la configuration des objectifssla:read

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/sla-targets" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PUT/v1/sla-targetsCréer ou remplacer un objectifsla:writerejouable

    Un objectif par scénario, plus un objectif global sans `monitorId`. Rappeler la même cible remplace l'objectif existant.

    Paramètres

    NomOùTypeBornesDéfautDescription
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Rejoue la même réponse pendant 24 heures au lieu de créer un doublon. Indispensable dans un pipeline qui peut réessayer.

    Corps de la requête

    NomTypeBornesDéfautDescription
    monitorIdstring <uuid>——
    namestring≤ 120 car.—
    objectivePct*number50–100—
    windowDays*integer1–365—
    excludeMaintenanceboolean——
    warnAtBudgetRationumber0.1–1—
    enabledboolean——

    Réponses

    CodeDescription
    200Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    409`Idempotency-Key` déjà utilisée avec un autre corps.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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}Lire un objectifsla:read

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/sla-targets/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • DELETE/v1/sla-targets/{id}Supprimer un objectifsla:write

    Paramètres

    NomOùTypeBornesDéfautDescription
    id*pathstring <uuid>——Identifiant.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    404Ressource introuvable dans cette organisation.
    429Trop d'appels pour cette clé.

    Exemple d’appel

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

org

  • GET/v1/settingsLire les réglages de l'organisationorg:read

    Les secrets d'intégration ne sortent jamais : ils apparaissent sous forme de booléens `has*`.

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/settingsModifier les réglages de l'organisationorg:write

    Sous-ensemble sans secret. Slack, Teams, Discord, PagerDuty, Opsgenie, Datadog et Sentry restent réservés au back-office, pour ne pas écrire de secret dans un fichier d'infrastructure.

    Paramètres

    Aucun paramètre.

    Corps de la requête

    Corps facultatif : seuls les champs transmis sont modifiés.

    NomTypeBornesDéfautDescription
    alertEmailstring <email>——
    alertOnRecoveryboolean——
    escalationAfterFailsinteger2–20—
    escalationEmailstring <email>——
    weeklyDigestEmailstring <email>——
    weeklyDigestEnabledboolean——
    statusSlugstring≤ 64 car.—
    statusPublicboolean——
    timezonestring≤ 64 car.—
    sslWarnDaysarray<integer>≤ 6 élém.—
    domainWarnDaysarray<integer>≤ 6 élém.—
    triageEnabledboolean——
    triageConfirmEnabledboolean——
    triageLatencyFactornumber1.5–10—

    Réponses

    CodeDescription
    200Succès.
    400Corps ou paramètre invalide.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    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/usageConsommation de la périodeorg:read

    De quoi couper un pipeline avant d'épuiser le quota.

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/usage" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/status/componentsComposants de la page de statut publiqueorg:read

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/status/components" \
  -H "Authorization: Bearer $PATHLY_TOKEN"

members

  • GET/v1/membersLister les membres de l'organisationmembers:read

    Nom, adresse et rôle des comptes rattachés, pour rapprocher un incident de son responsable. Aucune invitation ni modification par clé d'API.

    Paramètres

    Aucun paramètre.

    Réponses

    CodeDescription
    200Succès.
    401Clé d'API absente, inconnue, révoquée ou expirée.
    403La clé ne porte pas la portée exigée.
    429Trop d'appels pour cette clé.

    Exemple d’appel

    curl "https://api.pathlyhq.com/v1/members" \
  -H "Authorization: Bearer $PATHLY_TOKEN"