Aller au contenu principal
SecuScan
Documentation

Documentation SecuScan

Guides de démarrage, référence API et configuration pour tirer le meilleur de SecuScan.

Guides de démarrage

Suivez ces guides pour configurer rapidement chaque module de SecuScan.

Démarrage rapide

Créez votre compte, ajoutez votre première cible et lancez un scan en 5 minutes.

  1. 1Créez votre compte sur scanyze.com
  2. 2Ajoutez votre domaine comme cible
  3. 3Lancez votre premier scan
  4. 4Consultez les résultats et recommandations

Installer un agent

Déployez un agent léger sur vos serveurs pour une surveillance continue.

  1. 1Téléchargez le binaire pour votre OS
  2. 2Configurez votre API key: --key YOUR_TOKEN
  3. 3Lancez: ./secuscan-agent --api https://api.scanyze.com
  4. 4Visualisez l'agent dans votre dashboard

Scanner votre code

Connectez vos repositories Git pour détecter secrets et vulnérabilités.

  1. 1Ajoutez votre clé SSH dans Paramètres > Clés SSH
  2. 2Ajoutez votre repository Git (GitHub, GitLab, Bitbucket)
  3. 3Lancez un scan de code
  4. 4Consultez les issues détectées avec recommandations IA

Référence API REST

Tous les endpoints disponibles. Authentification via JWT Bearer token. Base URL : https://api.scanyze.com/v1

Authentification

Toutes les requêtes API nécessitent une authentification via l'une de ces méthodes :

JWT Bearer TokenAuthorization: Bearer <token>
Clé APIX-API-Key: sk_live_xxx

Limites de requêtes

Free10 req/min
Starter50 req/min
Pro200 req/min
Business1 000 req/min
Enterprise10 000 req/min

Authentification

MéthodePoint de terminaisonDescription
POST
/v1/auth/registerCréer un nouveau compte
POST
/v1/auth/loginConnexion et obtention du token JWT
POST
/v1/auth/refreshRafraîchir un token expiré

Cibles

MéthodePoint de terminaisonDescription
POST
/v1/targetsCréer une nouvelle cible
GET
/v1/targetsLister toutes les cibles
GET
/v1/targets/{id}Détails d'une cible
PUT
/v1/targets/{id}Mettre à jour une cible
DELETE
/v1/targets/{id}Supprimer une cible

Scans

MéthodePoint de terminaisonDescription
POST
/v1/scansLancer un scan
GET
/v1/scansLister tous les scans
GET
/v1/scans/{id}Détails d'un scan
POST
/v1/scans/{id}/cancelAnnuler un scan en cours
GET
/v1/scans/{id}/findingsVulnérabilités d'un scan
GET
/v1/scans/{id}/summaryRésumé d'un scan

Vulnérabilités

MéthodePoint de terminaisonDescription
GET
/v1/findingsLister toutes les vulnérabilités
GET
/v1/findings/{id}Détails d'une vulnérabilité
PATCH
/v1/findings/{id}/statusMettre à jour le statut
GET
/v1/findings/statsStatistiques globales

Rapports

MéthodePoint de terminaisonDescription
POST
/v1/reportsGénérer un rapport
GET
/v1/reportsLister tous les rapports
GET
/v1/reports/{id}Détails d'un rapport
GET
/v1/reports/{id}/downloadTélécharger le rapport (PDF/CSV/JSON)

Agents

MéthodePoint de terminaisonDescription
GET
/v1/agentsLister tous les agents
GET
/v1/agents/{id}Détails et statut d'un agent
POST
/v1/agents/registerEnregistrer un nouvel agent
DELETE
/v1/agents/{id}Supprimer un agent
GET
/v1/agents/{id}/inventoriesInventaires système de l'agent

Pentests

MéthodePoint de terminaisonDescription
POST
/v1/pentestsLancer un pentest IA
GET
/v1/pentestsLister tous les pentests
GET
/v1/pentests/{id}Détails et résultats d'un pentest

Sécurité Cloud

MéthodePoint de terminaisonDescription
GET
/v1/cloud/connectorsLister les connecteurs cloud
POST
/v1/cloud/connectorsAjouter un connecteur (M365/GWS)
GET
/v1/cloud/postureScore de posture cloud

Analyse de Code

MéthodePoint de terminaisonDescription
POST
/v1/code/repositoriesAjouter un dépôt
GET
/v1/code/repositoriesLister les dépôts
POST
/v1/code/scansLancer un scan de code
GET
/v1/code/scansLister les scans de code
GET
/v1/code/issuesLister les problèmes de sécurité

Webhooks

MéthodePoint de terminaisonDescription
GET
/v1/webhooksLister les webhooks
POST
/v1/webhooksCréer un webhook
PUT
/v1/webhooks/{id}Modifier un webhook
DELETE
/v1/webhooks/{id}Supprimer un webhook
POST
/v1/webhooks/{id}/testTester un webhook

Facturation

MéthodePoint de terminaisonDescription
GET
/v1/billing/planDétails du plan actuel
GET
/v1/billing/usageMétriques d'utilisation
GET
/v1/billing/limitsLimites du plan

Clés SSH

MéthodePoint de terminaisonDescription
GET
/v1/ssh-keysLister les clés SSH
POST
/v1/ssh-keysAjouter une clé SSH
DELETE
/v1/ssh-keys/{id}Supprimer une clé SSH

Événements Webhook

scan.completed
scan.failed
finding.new
finding.critical
agent.offline

CLI de l'agent

L'agent SecuScan est un binaire léger (5-7MB) disponible pour Linux, macOS et Windows.

Installation

Les instructions de téléchargement et les sommes de contrôle sont disponibles dans votre tableau de bord SecuScan après connexion. Allez dans Paramètres → Agents pour télécharger l'agent pour votre plateforme.

Plateformes supportées

Linux - amd64, arm64
macOS - Intel, Apple Silicon
Windows - amd64

Prêt à commencer?

Créez votre compte gratuitement et lancez votre premier scan en quelques minutes.

Essai gratuit 14 joursConsulter la FAQ