Panoramica dell'API

L’API Arlet ti consente di gestire repository, eseguire analisi del codice, eseguire codice e configurare integrazioni in modo programmatico. Tutti gli endpoint utilizzano JSON su HTTPS.

URL base

https://api.arlet.dev

Versionamento

Tutti gli endpoint delle risorse hanno il prefisso /v1. Gli endpoint OAuth e di discovery non sono versionati.

Autenticazione

La maggior parte degli endpoint richiede un token Bearer. Passalo nell’header Authorization:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.arlet.dev/v1/repositories

Puoi creare e gestire le chiavi API dal pannello di controllo o tramite gli endpoint delle chiavi API.

Formato delle risposte

Tutte le risposte restituiscono JSON. Le risposte di successo utilizzano codici di stato HTTP standard:

Codice	Significato
`200`	Successo
`201`	Risorsa creata
`204`	Successo senza corpo risposta
`422`	Errore di validazione

Risposte di errore

Gli errori di validazione restituiscono uno stato 422 con dettagli sui campi che hanno fallito la validazione:

{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "description of the error",
      "type": "error_type"
    }
  ]
}

Gruppi di endpoint

Usa la barra laterale per esplorare tutti gli endpoint disponibili, organizzati per gruppo:

Repository — registrare, elencare e gestire i repository
File del repository — esplorare i file all’interno di un repository
Analisi del codice — avviare, monitorare e gestire le analisi del codice
Esecuzione del codice — eseguire codice e recuperare i risultati dell’esecuzione
Streaming di esecuzione — trasmettere log stdout/stderr in tempo reale tramite SSE
Chiavi API — creare e revocare chiavi API
Variabili d’ambiente — gestire le variabili d’ambiente per l’esecuzione
Integrazione GitHub — connettere e gestire i repository GitHub
GitHub App Webhooks — ricevere eventi push e pull request per l’analisi automatizzata
OAuth 2.0 — autorizzazione, token e registrazione client

​URL base

​Versionamento

​Autenticazione

​Formato delle risposte

​Risposte di errore

​Gruppi di endpoint