{"openapi":"3.1.0","info":{"title":"API CybRelay v1","version":"1.0.0","description":"Analyse de rapports de sécurité et scripts de correction. Moteur cybrelay-engine 1.0.0. Accès : l'offre Entreprise ; le pipeline CI (POST /api/v1/scan) est inclus dans toutes les offres. Quotas par minute et par espace : Gratuite 30, Starter 60, Pro 120, Entreprise 600."},"servers":[{"url":"https://api.cybrelay.com"}],"security":[{"cleApi":[]}],"components":{"securitySchemes":{"cleApi":{"type":"http","scheme":"bearer","description":"Clé d'API de l'espace : Paramètres → Fiche Société → Clé d'API organisationnelle."}},"headers":{"X-RateLimit-Limit":{"description":"Appels autorisés par minute pour cet espace","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Appels restants dans la minute","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Heure (secondes Unix) à laquelle un appel se libère","schema":{"type":"integer"}}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]},"Engine":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}},"AnalysisRequest":{"type":"object","required":["fileName","fileContent"],"properties":{"fileName":{"type":"string","description":"Nom du fichier (sert à reconnaître le format), ex. trivy.json, scan.sarif, rapport.nessus"},"fileContent":{"type":"string","description":"Contenu texte du rapport ou du code (15 Mo au plus)"},"projectReference":{"type":"string","description":"Référence du projet CybRelay (PRJ-XXXX) où ranger l’analyse"},"repository":{"type":"string","description":"Adresse du dépôt (rangement automatique par dépôt)"},"branch":{"type":"string","description":"Branche (rangement automatique par branche)"},"failOn":{"type":"string","enum":["p1","p2","none"],"default":"none","description":"Décision bloquante (gate) : p1, p2 ou none"}}},"AnalysisCreated":{"type":"object","properties":{"success":{"type":"boolean"},"analysisId":{"type":"string"},"duplicate":{"type":"boolean"},"creditsDebited":{"type":"integer"},"creditsRemaining":{"type":"integer"},"uniqueFindings":{"type":"integer"},"severity":{"type":"object","additionalProperties":{"type":"integer"}},"gate":{"type":"object","properties":{"failOn":{"type":"string"},"failed":{"type":"boolean"},"p1":{"type":"integer"},"p2":{"type":"integer"},"p3":{"type":"integer"},"p4":{"type":"integer"}}},"engine":{"$ref":"#/components/schemas/Engine"},"links":{"type":"object","properties":{"analysis":{"type":"string"}}}}},"Finding":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"severity":{"type":"string","enum":["critical","high","medium","low","info"]},"priority":{"type":"string","enum":["P1-Urgent","P2-High","P3-Medium","P4-Low"]},"cwe":{"type":["string","null"]},"cve":{"type":["string","null"]},"cvssScore":{"type":["number","null"]},"location":{"type":"object","properties":{"file":{"type":["string","null"]},"line":{"type":["integer","null"]}}},"recommendation":{"type":["string","null"]},"status":{"type":"string"},"links":{"type":"object","properties":{"script":{"type":"string"}}}}}}},"paths":{"/api/v1/analyses":{"post":{"summary":"Lancer une analyse","description":"Analyse un rapport de scanner (SARIF, Trivy, Snyk, Nessus, SonarQube, Checkmarx, OWASP ZAP), du code source ou un dossier. Même barème qu'à l'import sur le site (forfait d'ingestion + 1 crédit par faille unique). Un rapport identique déjà analysé n'est pas débité une seconde fois. 60 analyses par heure au plus. Les rapports PDF s'importent sur le site.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}}},"responses":{"200":{"description":"Rapport identique déjà analysé : même analyse, 0 crédit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisCreated"}}}},"201":{"description":"Analyse créée et crédits débités","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisCreated"}}}},"400":{"description":"Champs manquants ou invalides","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Crédits insuffisants","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Fichier trop volumineux","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Quota dépassé (voir Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erreur interne, aucun crédit débité","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/analyses/{id}":{"get":{"summary":"Suivre une analyse","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"État et synthèse (gravité, priorité, score)"},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Analyse introuvable dans cet espace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Quota dépassé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/analyses/{id}/findings":{"get":{"summary":"Failles d'une analyse","description":"Failles triées par priorité, avec fichier et ligne. Le code source envoyé n’est jamais renvoyé.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Liste des failles","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer"},"findings":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}}}}}}},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Analyse introuvable dans cet espace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Quota dépassé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/findings/{id}/script":{"get":{"summary":"Script de correction","description":"Script du moteur CybRelay (Bash ou Python), avec les conseils de l'IA en commentaires, produits une fois par faille et compris dans l'analyse. Aucun crédit débité. À relire avant exécution.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["bash","python"],"default":"bash"}}],"responses":{"200":{"description":"Script de correction"},"400":{"description":"Langage invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Faille introuvable dans cet espace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Quota dépassé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/surface-scans":{"post":{"summary":"Scan SURFACE d’un site (agents IA)","description":"Contrôles passifs de configuration (en-têtes HTTP, TLS, redirection HTTPS, cookies, DNS de messagerie, security.txt), note de A+ à F. Aucun test d'intrusion ; l'audit DEEP (actif) reste réservé au propriétaire vérifié du domaine. Toutes les offres. 1 scan gratuit par jour pour l'espace, puis 2 crédits par scan (prix de la page publique), débités seulement si le scan réussit. Masqué de la liste publique par défaut (hidden=false pour publier). Résultat lisible 48 h.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","example":"https://exemple.com"},"hidden":{"type":"boolean","default":true}}}}}},"responses":{"200":{"description":"Note, score, contrôles, lien de résultat (48 h), crédits débités et restants"},"400":{"description":"Adresse invalide, interne ou non publique (aucun crédit débité)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Crédits insuffisants (aucun scan lancé)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite atteinte (par domaine et par heure, ou par minute pour l’espace)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Site injoignable (aucun crédit débité)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/surface-scans/{id}":{"get":{"summary":"Relire un scan SURFACE","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Résultat complet (48 h)"},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Scan introuvable dans cet espace ou expiré","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Quota dépassé","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/scan":{"post":{"summary":"Pipeline CI (gate)","description":"Utilisé par le workflow GitHub Actions CybRelay : analyse + décision bloquante (failOn = p1 par défaut).","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisRequest"}}}},"responses":{"200":{"description":"Analyse et décision du gate"},"400":{"description":"Champs manquants ou invalides","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Clé absente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Crédits insuffisants","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Clé invalide","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Fichier trop volumineux","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite horaire atteinte","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}