Black Friday tra 20 giorni: i Suoi clienti potranno pagare? -25 % il 1° anno e configurazione offerta, fino al 30 novembreVedi l’offerta →

PathlyAnalizza il mio sito

Integrazione

Riferimento degli endpoint /v1

Elenco letto dal contratto OpenAPI al rendering: un endpoint rimosso scompare da solo.

Ottenere la mia chiave APIContratto OpenAPI

Documento completo, senza autenticazione, da passare al Suo generatore di client.

Endpoint

Elenco letto dal contratto al momento del rendering: non può descrivere un endpoint che non esiste più.

Riepiloghi, descrizioni e limiti provengono dal contratto OpenAPI, servito nella lingua di questa pagina. Path, tipi e ambiti sono identici in tutte le lingue.

47 / 47

assistant

  • POST/v1/flow-assistant/detectLumi: riconoscere un sitoassistant:run

    Legge la home page (protezione SSRF), indica il tipo di sito e se restano prove per oggi. Non consuma prove. `available: false` con `reason`: `off` (assistente in pausa), `url_blocked`, `unreachable` o `quota`.

    Parametri

    Nessun parametro.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    url*string≤ 2000 car.—

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/flow-assistant/detect" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://boutique.example.com"}'
  • POST/v1/flow-assistant/trialsLumi: preparare dei Flowassistant:runripetibile

    Avvia una prova (202, `{ id }`), poi la legga fino a `ready`, `not_found` o `failed`. Stessi limiti dell’app: prove al giorno del piano (403 `assistant_quota`), tetto di costo dell’IA, interruttore `kill_flow_assistant` (403 `assistant_off`), coda piena (429 `assistant_busy`). `confirmOwner: true`: Lei gestisce questo sito.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    url*string≤ 2000 car.—
    confirmOwner*any——

    Risposte

    CodiceDescrizione
    202Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/flow-assistant/trials" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://boutique.example.com","confirmOwner":true}'
  • GET/v1/flow-assistant/trials/{id}Lumi: leggere una provaassistant:run

    Stato della prova e, una volta pronta, i Flow rieseguiti con successo (`proposals`), i posti Flow residui (`slots`) e la frequenza consigliata (`advice`).

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/flow-assistant/trials/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/flow-assistant/trials/{id}/saveLumi: salvare un Flow propostoassistant:saveripetibile

    Crea il Flow `index` della prova e avvia la sua prima esecuzione. Entro i limiti del piano (403 `PLAN_LIMIT`). Già salvato: 409 `already_saved` con `monitorId`. Chiave limitata a uno Spazio: il Flow entra nel suo Spazio.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    index*integer0–9—
    namestring≤ 120 car.—
    intervalSecinteger60–604800—
    stepsarray<object>2–50 élém.—

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/flow-assistant/trials/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90/save" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"index":0,"name":"Tunnel de commande"}'

status

  • GET/v1/status-pagesElencare le pagine di statostatus:read

    La pagina dell’organizzazione (`kind: organization`, `id` = organizzazione) e quelle degli Spazi (`kind: space`, `id` = Spazio), con il loro indirizzo pubblico (`url`) e il loro badge SVG (`badgeUrl`, `?v=uptime` per la disponibilità). Il badge della pagina dell’organizzazione richiede `?monitor=<scenarioId>` quando conta più scenari. Chiave limitata a uno Spazio: solo la pagina del suo Spazio.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/status-pages" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/status-pagesCreare una pagina di statostatus:writeripetibile

    Senza `spaceId`: la pagina dell’organizzazione, all’indirizzo `slug` (proposto in base al nome se assente). Con `spaceId`: la pagina dello Spazio, sotto l’indirizzo dell’organizzazione, creata se necessario. Non pubblicata salvo `public: true`. Già presente: restituita così com’è. Un indirizzo già occupato: 409.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    spaceIdstring <uuid>——
    slugstring≤ 64 car., /^[a-z0-9]+(-[a-z0-9]+)*$/—
    publicboolean——

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/status-pages" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"slug":"boutique-exemple","public":true}'
  • GET/v1/status-pages/{id}Leggere una pagina di statostatus:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/status-pages/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/status-pages/{id}Pubblicare o ritirare una pagina di statostatus:write

    `public` pubblica o ritira la pubblicazione. `slug` cambia l’indirizzo della pagina dell’organizzazione: i link e i badge già inseriti smettono di rispondere.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Corpo della richiesta

    Corpo facoltativo: vengono modificati solo i campi inviati.

    NomeTipoLimitiPredefinitoDescrizione
    publicboolean——
    slugstring≤ 64 car., /^[a-z0-9]+(-[a-z0-9]+)*$/—

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X PATCH "https://api.pathlyhq.com/v1/status-pages/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"public":false}'

scenarios

  • GET/v1/scenariosElencare gli scenariscenarios:read

    Il percorso di uno scenario browser non viene restituito: contiene credenziali di accesso. `scenarioFingerprint` cambia non appena viene modificato, il che basta a rilevare una deriva.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    limitqueryinteger1–500100Dimensione della pagina, 100 per impostazione predefinita.
    cursorquerystring——Valore `nextCursor` della risposta precedente. Assente nell’ultima pagina.
    space_idquerystring <uuid>——Solo gli scenari di questo Spazio. Una chiave limitata a uno Spazio vede solo il proprio.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/scenarios?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/scenariosCreare uno scenarioscenarios:writeripetibile

    `type: http` richiede `url` o `httpChain`. `type: browser` richiede `scenario`. `enabled: false` prepara uno scenario senza far scattare alcun avviso. Ripetibile con `Idempotency-Key`.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    name*string≤ 120 car.—
    type"http" | "browser"—"http"
    urlstring <uri>——Obbligatoria per un controllo HTTP.
    intervalSec*integer0–2592000—0 = nessuna pianificazione.
    method"GET" | "HEAD"—"GET"
    expectedStatusinteger100–599—
    maxLatencyMsinteger100–600000—
    expectTextstring≤ 500 car.—
    regionsarray<string>≤ 8 élém.—
    scenarioobject——Albero del percorso: elenco di passaggi (`goto`, `click`, `fill`, `assert_text`…) e, per una catena HTTP, `httpChain`. Veda la documentazione degli scenari.
    tagsarray<string>≤ 10 élém.—
    folderstring≤ 60 car.—
    severity"critical" | "major" | "minor"——
    runbookstring≤ 2000 car.—
    cronstring≤ 120 car.—5 campi, ad es. `0 9 * * 1-5`.
    enabledboolean——
    spaceIdstring <uuid>——Spazio dello scenario. Una chiave limitata a uno Spazio lo impone e rifiuta un altro Spazio.
    httpChainarray<object>——

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}Leggere uno scenarioscenarios:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Corpo della richiesta

    Corpo facoltativo: vengono modificati solo i campi inviati.

    NomeTipoLimitiPredefinitoDescrizione
    namestring≤ 120 car.—
    urlstring <uri>——Solo controllo HTTP.
    intervalSecinteger0–2592000—
    method"GET" | "HEAD"——
    expectedStatusinteger100–599—
    maxLatencyMsinteger100–600000—
    enabledboolean——
    expectTextstring≤ 500 car.—
    regionsarray<string>≤ 8 élém.—
    scenarioobject——Albero del percorso: elenco di passaggi (`goto`, `click`, `fill`, `assert_text`…) e, per una catena HTTP, `httpChain`. Veda la documentazione degli scenari.
    tagsarray<string>≤ 10 élém.—
    folderstring≤ 60 car.—
    severity"critical" | "major" | "minor"——
    runbookstring≤ 2000 car.—
    cronstring≤ 120 car.—
    httpChainarray<object>——
    spaceIdstring <uuid>——

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}Eliminare uno scenarioscenarios:write

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X DELETE "https://api.pathlyhq.com/v1/scenarios/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/scenarios/{id}/muteSilenziare uno scenarioscenarios:write

    `mutedUntil: null` riattiva lo scenario. Scadenza limitata a 30 giorni.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    mutedUntil*string <date-time>——

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}/baselineFissare il riferimento di confronto sull’ultima esecuzione riuscitascenarios:write

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}/runAvviare un’esecuzioneruns:trigger

    Mette in coda un’esecuzione e restituisce il suo `jobId`. Consuma quota: ambito `runs:trigger`.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    scenarioIdquerystring <uuid>——Filtra su uno scenario.
    limitqueryinteger1–500100Dimensione della pagina, 100 per impostazione predefinita.
    cursorquerystring——Valore `nextCursor` della risposta precedente. Assente nell’ultima pagina.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/runs?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/runs/{id}Leggere un’esecuzione e il suo esitoruns:read

    `screenshotUrl`: link firmato allo screenshot del passaggio fallito, valido 15 minuti (`screenshotExpiresAt`), senza chiave. `null` senza screenshot. Rilegga l’esecuzione per ottenere un nuovo link.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

incidents

  • GET/v1/incidentsElencare gli incidentiincidents:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    limitqueryinteger1–500100Dimensione della pagina, 100 per impostazione predefinita.
    cursorquerystring——Valore `nextCursor` della risposta precedente. Assente nell’ultima pagina.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/incidents?limit=100" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/incidents/{id}Chiudere un incidente o pubblicarne il resocontoincidents:write

    Riaprire un incidente cancella la sua data di risoluzione. `publicPostmortem` pubblica il resoconto sulla pagina di stato: da riservare a un testo riletto.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Corpo della richiesta

    Corpo facoltativo: vengono modificati solo i campi inviati.

    NomeTipoLimitiPredefinitoDescrizione
    status"open" | "resolved"——
    postmortemstring≤ 20000 car.—
    publicPostmortemboolean——

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}'
  • GET/v1/hooks/samplesEsempi di eventi di incidenteincidents:read

    Gli ultimi tre incidenti, nel formato esatto dell’evento inviato. Serve a Zapier e Make per preparare la corrispondenza dei campi.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    eventquery"incident.opened" | "incident.resolved"——Evento desiderato. `incident.resolved` restituisce solo incidenti risolti.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

alerting

  • GET/v1/webhooksElencare i webhook in uscitaalerting:read

    L’URL registrato non viene mai restituito: è cifrato a riposo. `urlFingerprint` cambia se cambia la destinazione, il che basta a rilevare una deriva.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/webhooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/webhooksCreare un webhook in uscitaalerting:writeripetibile

    Restituisce il segreto di firma una sola volta, alla creazione. Sono accettati solo URL pubblici https.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    url*string <uri>≤ 500 car.—
    eventsarray<"run.failed" | "run.recovered" | "incident.opened" | "incident.resolved">≥ 1 élém.—

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}Leggere un webhook in uscitaalerting:read

    Eventi ascoltati, stato e impronta della destinazione. L’URL resta cifrato.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X DELETE "https://api.pathlyhq.com/v1/webhooks/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/hooksIscriversi a un evento di incidente (REST hooks)alerting:writeripetibile

    Per Zapier, Make o qualsiasi strumento di automazione: Pathly invia `incident.opened` o `incident.resolved` a `targetUrl`, firmato come un webhook. Richiede anche l’ambito `incidents:read`. Una chiave limitata a uno Spazio riceve solo gli incidenti del proprio Spazio. Una destinazione che risponde 410 viene disiscritta. Sono accettati solo URL pubblici https.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    targetUrl*string <uri>≤ 500 car.—
    event*"incident.opened" | "incident.resolved"——
    source"zapier" | "make" | "n8n" | "api"——

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/hooks" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Idempotency-Key: deploy-2026-09-23-01" \
  -H "Content-Type: application/json" \
  -d '{"targetUrl":"https://hooks.example.com/catch/123/abc","event":"incident.opened","source":"zapier"}'
  • DELETE/v1/hooks/{id}Annullare l’iscrizione a un evento di incidentealerting:write

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

maintenance

  • GET/v1/maintenance-windowsElencare le finestre di manutenzionemaintenance:read

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/maintenance-windowsCreare una finestra di manutenzionemaintenance:writeripetibile

    Due forme: una tantum (`startsAt` e `endsAt`) o settimanale (`weekday`, `startMinute`, `durationMin`).

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    monitorIdstring <uuid>——Assente = tutta l’organizzazione.
    startsAtstring <date-time>——Finestra una tantum.
    endsAtstring <date-time>——Finestra una tantum, 90 giorni al massimo.
    reasonstring≤ 500 car.—
    weekdayinteger1–7—Finestra settimanale, 1 = lunedì.
    startMinuteinteger0–1439—
    durationMininteger15–1440—

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}Leggere una finestra di manutenzionemaintenance:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/maintenance-windows/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • DELETE/v1/maintenance-windows/{id}Eliminare una finestra di manutenzionemaintenance:write

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

sla

  • GET/v1/slaMisura degli obiettivi di disponibilitàsla:read

    Tasso misurato e budget di errore residuo, per obiettivo.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/sla" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/sla-targetsElencare la configurazione degli obiettivisla:read

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/sla-targets" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PUT/v1/sla-targetsCreare o sostituire un obiettivosla:writeripetibile

    Un obiettivo per scenario, più un obiettivo globale senza `monitorId`. Una nuova chiamata sullo stesso bersaglio sostituisce l’obiettivo esistente.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    Idempotency-Keyheaderstring8–128 car., /^[A-Za-z0-9._:-]+$/—Restituisce la stessa risposta per 24 ore invece di creare un duplicato. Indispensabile in una pipeline che può riprovare.

    Corpo della richiesta

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

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    409`Idempotency-Key` già usata con un altro corpo.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    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}Leggere un obiettivosla:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

org

  • GET/v1/settingsLeggere le impostazioni dell’organizzazioneorg:read

    I segreti di integrazione non escono mai: compaiono come booleani `has*`.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/settingsModificare le impostazioni dell’organizzazioneorg:write

    Sottoinsieme senza segreti. Slack, Teams, Discord, PagerDuty, Opsgenie, Datadog e Sentry restano riservati al back-office, per non scrivere segreti in un file di infrastruttura.

    Parametri

    Nessun parametro.

    Corpo della richiesta

    Corpo facoltativo: vengono modificati solo i campi inviati.

    NomeTipoLimitiPredefinitoDescrizione
    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—

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X PATCH "https://api.pathlyhq.com/v1/settings" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alertEmail":"[email protected]","alertOnRecovery":true,"escalationAfterFails":3,"timezone":"Europe/Paris"}'
  • GET/v1/usageConsumo del periodoorg:read

    Quanto basta per fermare una pipeline prima di esaurire la quota.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/usage" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/spacesElencare gli Spaziorg:read

    Uno Spazio raggruppa gli scenari di un cliente, di un marchio o di un’applicazione. Risponde 404 finché gli Spazi non sono attivati per l’organizzazione. Una chiave limitata a uno Spazio vede solo il proprio.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/spaces" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • POST/v1/spacesCreare uno Spazioorg:write

    Entro i limiti del piano. Rifiutato a una chiave limitata a uno Spazio.

    Parametri

    Nessun parametro.

    Corpo della richiesta

    NomeTipoLimitiPredefinitoDescrizione
    name*string≤ 80 car.—
    kind"client" | "site" | "application"——

    Risposte

    CodiceDescrizione
    201Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X POST "https://api.pathlyhq.com/v1/spaces" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Boutique en ligne","kind":"client"}'
  • GET/v1/spaces/{id}Leggere uno Spazioorg:read

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/spaces/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • PATCH/v1/spaces/{id}Modificare uno Spazioorg:write

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Corpo della richiesta

    Corpo facoltativo: vengono modificati solo i campi inviati.

    NomeTipoLimitiPredefinitoDescrizione
    namestring≤ 80 car.—
    kind"client" | "site" | "application"——

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    400Corpo o parametro non valido.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X PATCH "https://api.pathlyhq.com/v1/spaces/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Boutique"}'
  • DELETE/v1/spaces/{id}Archiviare uno Spazioorg:write

    I suoi scenari ne escono e restano monitorati. Nulla viene eliminato.

    Parametri

    NomeDoveTipoLimitiPredefinitoDescrizione
    id*pathstring <uuid>——Identificativo.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    404Risorsa non trovata in questa organizzazione.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl -X DELETE "https://api.pathlyhq.com/v1/spaces/8f14e45f-ea8d-4b4c-9c0a-3b2d1e6f7a90" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/status/componentsComponenti della pagina di stato pubblicaorg:read

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

    curl "https://api.pathlyhq.com/v1/status/components" \
  -H "Authorization: Bearer $PATHLY_TOKEN"
  • GET/v1/accountOrganizzazione, piano e quoteorg:read

    Nome dell’organizzazione, piano, quote usate e residue (`limit: null` = senza quota), e `billingUrl`, la schermata Piano dell’app. Chiave limitata a uno Spazio: `used` conta solo il suo Spazio, `limit` e `remaining` restano quelli dell’organizzazione, di cui lo Spazio condivide le quote.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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

members

  • GET/v1/membersElencare i membri dell’organizzazionemembers:read

    Nome, indirizzo e ruolo degli account collegati, per associare un incidente al suo responsabile. Nessun invito né modifica tramite chiave API.

    Parametri

    Nessun parametro.

    Risposte

    CodiceDescrizione
    200Operazione riuscita.
    401Chiave API assente, sconosciuta, revocata o scaduta.
    403La chiave non ha l’ambito richiesto.
    429Troppe chiamate per questa chiave.

    Esempio di chiamata

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