API › Scans

Historique des scans

Les scans d'un projet, du plus récent au plus ancien. La profondeur de l'historique dépend de ton offre.

GEThttps://api.rustine.io/v1/projects/{project_id}/scans

Permission OAuth : scans:read · une clé d'API les a toutes

Ouvrir dans Claude Ouvrir dans ChatGPT

Paramètres de chemin

project_idstringobligatoire
Le projet.

Paramètres de requête

limitintegeroptionnel
Combien d'éléments par page, de 1 à 100 (20 par défaut).
starting_afterstringoptionnel
Le curseur : l'identifiant du dernier élément de la page précédente.

Réponse

objectstring
Le type d'objet, toujours le même pour une route donnée.
dataarray of object
Les éléments de la page.
- idstring
  L'identifiant du scan.
- objectstring
  Le type d'objet, toujours le même pour une route donnée.
- target_idstring
  Le site ou le dépôt scanné.
- kindstring
  quick (ce que tout visiteur voit), audit (ajoute des contrôles en lecture seule, sites prouvés seulement) ou repository (analyse d'un dépôt GitHub).
  quickauditrepository
- statusstring
  Les scans tournent en arrière-plan : interroge jusqu'à done ou failed.
  queuedrunningdonefailed
- scorenumber | null
  Le score sur 100, une fois terminé.
- gradestring | null
  La note, une fois terminé.
  ABCDF
- coveragenumber | null
  La part des contrôles qui ont pu tourner (de 0 à 1), une fois terminé.
- audit_fallbackboolean
  Un audit était demandé mais la preuve du site ne tenait plus : un scan rapide a tourné à la place, et aucun audit n'a été décompté.
- reusedboolean
  Vrai quand la requête a reçu un scan existant au lieu d'un nouveau (un en cours, ou un du même type dans l'heure) ; rien n'a été décompté.
- next_real_scan_atstring | null
  Avec reused pour un scan récent : quand un nouveau scan de ce type pourra partir.
- created_atstring
  Quand il a été demandé (ISO 8601, UTC).
- finished_atstring | null
  Quand il s'est terminé, null tant qu'il tourne.
has_moreboolean
Vrai s'il reste des éléments après cette page : rappelle la route avec starting_after.

Erreurs

Code	error.code	Ce qui se passe
400	parameter_invalid	Un paramètre manque ou n'est pas valable ; `param` le nomme.
400	cursor_invalid	`starting_after` n'est l'identifiant d'aucun élément de cette liste.
401	authentication_required	Aucune clé dans la requête. Passe-la dans l'en-tête `Authorization: Bearer rst_…`, jamais dans l'adresse.
401	invalid_api_key	La clé ou le jeton OAuth est faux, révoqué ou expiré. Vérifie qu'il est copié en entier, ou crée une nouvelle clé.
402	api_plan_required	L'espace est sur l'offre Gratuite. L'API vient avec Pro, ou à l'essai 14 jours sur Solo.
402	api_trial_ended	L'essai de 14 jours de Solo est terminé. Passe à Pro : tes clés remarchent aussitôt.
403	scope_missing	Le jeton OAuth n'a pas la permission que demande cette route (indiquée sur sa page). Reconnecte l'agent pour l'accorder. Une clé d'API a toutes les permissions.
404	resource_not_found	Rien avec cet identifiant dans l'espace de la clé. Un objet d'un autre espace répond pareil : son existence n'est jamais révélée.
429	rate_limited	Trop de requêtes pour cette clé (120 par minute). Attends `Retry-After` secondes.
500	internal_error	Une erreur de notre côté, signalée automatiquement. Réessaie plus tard ; donne le `Request-Id` au support si elle revient.
503	service_unavailable	Rustine est indisponible un instant. Réessaie avec la même `Idempotency-Key`.