Skip to content

Référence API REST

Tous les endpoints sont préfixés par /api. Les endpoints authentifiés nécessitent un token Bearer dans l'en-tête Authorization.

http
Authorization: Bearer <token>

Une interface Swagger est disponible sur http://localhost:3000/docs en mode développement.

Authentification

EndpointMéthodeDescription
/api/auth/registerPOSTCréer un compte
/api/auth/loginPOSTS'authentifier
/api/auth/refreshPOSTRafraîchir le token d'accès
/api/auth/logoutPOSTInvalider le refresh token
/api/auth/registration-statusGETVérifier si l'inscription est activée

Projets

EndpointMéthodeDescription
/api/projectsGETLister les projets visibles
/api/projects/publicGETLister les projets publics
/api/projects/mineGETLister vos projets
/api/projectsPOSTCréer un projet
/api/projects/:idPATCHMettre à jour un projet
/api/projects/:idDELETESupprimer un projet

Pipelines

EndpointMéthodeDescription
/api/projects/:pid/pipelinesGETLister les pipelines
/api/projects/:pid/pipelinesPOSTCréer un pipeline
/api/projects/:pid/pipelines/:idGETObtenir un pipeline
/api/projects/:pid/pipelines/:idPUTSauvegarder l'état complet
/api/projects/:pid/pipelines/:id/execution-planGETPlan d'exécution (dry-run)
/api/projects/:pid/pipelines/:idDELETESupprimer un pipeline

Credentials

EndpointMéthodeDescription
/api/credentialsGETLister (valeurs masquées)
/api/credentialsPOSTCréer
/api/credentials/:idPUTMettre à jour
/api/credentials/:idDELETESupprimer

Clés API

EndpointMéthodeDescription
/api/api-keysGETLister
/api/api-keysPOSTCréer (rawKey visible une seule fois)
/api/api-keys/:id/revokePOSTRévoquer
/api/api-keys/:idDELETESupprimer définitivement

Codes HTTP

CodeSignification
200OK
201Créé
204Pas de contenu (suppression réussie)
400Erreur de validation
401Non authentifié
403Accès refusé
404Ressource introuvable
500Erreur serveur

Released under the MIT License.