Rustine docs
API

Référence de l'API

L'adresse, les formats et les conventions communes à toutes les routes de l'API v1, puis chaque route une par une.

Ouvrir dans ClaudeOuvrir dans ChatGPT

Adresse : https://api.rustine.io/v1

  • Authentification : Authorization: Bearer rst_… (Authentification).
  • Format : JSON en entrée et en sortie, champs en snake_case, dates en ISO 8601 (UTC), identifiants en UUID.
  • Listes : { "object": "list", "data": [...], "has_more": false }, avec limit et starting_after (Pagination).
  • Erreurs : { "error": { "type", "code", "message", "doc_url" } } (Erreurs).
  • Écritures : envoie une Idempotency-Key sur les POST (Idempotence).
  • Langue : les messages d’erreur et les textes des problèmes arrivent dans la langue du propriétaire de la clé.

Chaque réponse porte Request-Id (à donner au support), Rustine-Version (la version du contrat qui a répondu, voir Versions) et les en-têtes X-RateLimit-* (Limites et quotas).

La spécification complète est servie telle quelle sur /openapi.json (OpenAPI 3.1) : importe-la dans Postman, Insomnia ou un générateur de client.

Les routes

GET /projectsLister les projets
POST /projectsCréer un projet
GET /projects/{project_id}Lire un projet
POST /projects/{project_id}/targetsAjouter un site
POST /targets/{target_id}/scansLancer un scan
GET /scans/{scan_id}Suivre un scan
GET /projects/{project_id}/scansHistorique des scans
GET /projects/{project_id}/issuesLister les problèmes
GET /issues/{issue_id}Lire un problème
POST /issues/{issue_id}/fixDébloquer le correctif
GET /issues/{issue_id}/fixRelire le correctif
POST /issues/{issue_id}/recheckRevérifier
PATCH /issues/{issue_id}Marquer un problème
GET /accountTon offre et tes quotas

↵ Entrée pour ouvrir, Échap pour fermer