API CybRelay v1

Moteur cybrelay-engine 1.0.0 · Adresse : https://api.cybrelay.com · Description OpenAPI : /api/v1/openapi.json

Accès : l'API v1 complète (analyses, failles, scripts) est incluse dans l'offre Entreprise. Le pipeline CI (POST /api/v1/scan) est inclus dans toutes les offres. Une offre sans accès reçoit 403 avec un message clair.

1. Authentification

Chaque appel porte la clé d'API de votre espace dans l'en-tête Authorization. Elle se trouve dans Paramètres → Fiche Société → Clé d'API organisationnelle. Gardez-la dans un coffre de secrets (par exemple un secret GitHub), jamais dans le code.

Authorization: Bearer $CYBRELAY_API_KEY

2. Exemple complet

# 1. Lancer l'analyse d'un rapport Trivy
curl -sS -X POST "https://api.cybrelay.com/api/v1/analyses" \
  -H "Authorization: Bearer $CYBRELAY_API_KEY" -H "Content-Type: application/json" \
  --data "$(jq -n --arg n trivy.json --rawfile c trivy.json '{fileName:$n, fileContent:$c}')"

# 2. Lire les failles (identifiant renvoyé : analysisId)
curl -sS "https://api.cybrelay.com/api/v1/analyses/ANALYSIS_ID/findings" -H "Authorization: Bearer $CYBRELAY_API_KEY"

# 3. Obtenir le script de correction d'une faille
curl -sS "https://api.cybrelay.com/api/v1/findings/FINDING_ID/script?lang=bash" -H "Authorization: Bearer $CYBRELAY_API_KEY"

3. Adresses

POST /api/v1/analyses — Lancer une analyse

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.

Réponses : 200 201 400 401 402 403 413 429 500

GET /api/v1/analyses/{id} — Suivre une analyse

Réponses : 200 401 403 404 429

GET /api/v1/analyses/{id}/findings — Failles d'une analyse

Failles triées par priorité, avec fichier et ligne. Le code source envoyé n’est jamais renvoyé.

Réponses : 200 401 403 404 429

GET /api/v1/findings/{id}/script — Script de correction

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.

Réponses : 200 400 401 403 404 429

POST /api/v1/surface-scans — Scan SURFACE d’un site (agents IA)

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.

Réponses : 200 400 401 402 403 429 502

GET /api/v1/surface-scans/{id} — Relire un scan SURFACE

Réponses : 200 401 403 404 429

POST /api/v1/scan — Pipeline CI (gate)

Utilisé par le workflow GitHub Actions CybRelay : analyse + décision bloquante (failOn = p1 par défaut).

Réponses : 200 400 401 402 403 413 429

4. Crédits

5. Quotas

OffreAPI v1 complèteAppels par minute
Découvertenon (pipeline CI seulement)30
Starternon (pipeline CI seulement)60
Pronon (pipeline CI seulement)120
Entreprise & Sur mesureoui600

Chaque réponse porte X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset. Au-delà, la réponse est 429 avec Retry-After (secondes). Les analyses restent aussi limitées à 60 par heure. Taille maximale d'un fichier : 15 Mo.

6. Sécurité et confidentialité