Documentation

Deux documentations

Guide d'utilisationDu compte aux référentiels : chaque écran expliqué, avec captures annotées et gros plans.

API REST v1Authentification, alimentation de la stack, workflows en JSON et référence de chaque endpoint.

API : vue d’ensemble

L’API TechWatchAlert vous permet d’accéder programmatiquement à vos données de veille : CVE alertées, stacks surveillées et suivi End-of-Life, tous organisés par projet.

Clés API

Générez vos clés depuis Réglages de l’organisation → API (plan PRO requis, rôle admin). Chaque clé est rattachée à l’organisation et préfixée twa_.

Base URL

Tous les endpoints sont préfixés par https://app.techwatchalert.com/api/v1

Lecture, et deux écritures

L’API publique est en lecture. Deux écritures se cochent à part sur la clé : déposer un rapport de scanner (POST …/scans, scope scans) et créer ou modifier un workflow (POST …/workflows, scope workflows-write). TechWatchAlert ne lance pas de scan.

Format

Toutes les réponses sont en JSON. Les dates sont au format ISO 8601 avec timezone UTC.

Endpoints disponibles

Méthode	Endpoint	Description
GET	/v1/me	Organisation rattachée à la clé et son plan
GET	/v1/organizations	L’organisation rattachée à la clé
GET	/v1/organizations/{id}/projects	Projets d’une organisation
GET	/v1/organizations/{org_id}/projects/{id}	Détail d’un projet
GET	/v1/organizations/{org_id}/projects/{id}/stack	Stack de veille CVE d’un projet
GET	/v1/organizations/{org_id}/projects/{id}/alerts	Alertes CVE déclenchées sur un projet
GET	/v1/organizations/{org_id}/projects/{id}/alerts/{alert_id}	Détail d’une alerte CVE
GET	/v1/organizations/{org_id}/projects/{id}/eol	Abonnements End-of-Life d’un projet
GET	/v1/organizations/{org_id}/projects/{id}/urls	URLs surveillées (certificats, technos détectées)
GET	/v1/organizations/{org_id}/projects/{id}/urls/{url_id}	Détail d’une URL surveillée
GET	/v1/organizations/{org_id}/projects/{id}/cases	Cas de traitement des CVE (triage)
GET	/v1/organizations/{org_id}/projects/{id}/cases/{cve_id}	Détail d’un cas + historique
GET	/v1/organizations/{org_id}/projects/{id}/workflows	Workflows d’un projet (sans le graphe ; pas de GET unitaire)
POST	/v1/organizations/{org_id}/projects/{id}/workflows	Créer un workflow (scope workflows-write, Idempotency-Key, 201)
PATCH	/v1/organizations/{org_id}/projects/{id}/workflows/{workflow_id}	Modifier un workflow (version obligatoire)
PATCH	/v1/organizations/{org_id}/projects/{id}/workflows/{workflow_id}/enabled	Activer ou désactiver un workflow
DELETE	/v1/organizations/{org_id}/projects/{id}/workflows/{workflow_id}	Supprimer un workflow (204)
GET	/v1/organizations/{org_id}/projects/{id}/workflows/{workflow_id}/runs	Historique d’exécutions d’un workflow
GET	/v1/organizations/{org_id}/projects/{id}/stats	Statistiques du projet (alertes, KEV, PoC…)
POST	/v1/organizations/{org_id}/projects/{id}/scans	Dépôt d’un rapport de scanner (scope scans, 201)
GET	/v1/cves	Recherche dans la base CVE
GET	/v1/cves/{cve_id}	Fiche CVE complète
GET	/v1/articles	Flux d’articles de veille
GET	/v1/eol/products	Catalogue complet des produits EOL
GET	/v1/eol/products/{product_id}/cycles	Cycles de vie d’un produit
GET	/v1/statistics/timeseries	Volumétrie CVE par jour, semaine, mois, année
GET	/v1/statistics/top	Top CWE, éditeurs, produits, CNA sur une période
GET	/v1/statistics/top-trend	Évolution d’un classement dans le temps
GET	/v1/statistics/delays	Délais publication→KEV, réservation→publication, →PoC
GET	/v1/statistics/catalog	Dimensions, granularités et métriques disponibles
GET	/v1/statistics/distribution	Histogramme CVSS, paliers EPSS, vecteur d’attaque, couverture PoC
GET	/v1/statistics/totals	Compteurs globaux, y compris CVE rejetées et réservées

Codes HTTP

Code	Signification
200	Succès
201	Rapport de scanner déposé, ou workflow créé
401	Clé API manquante, invalide, révoquée ou expirée
403	Plan sans accès API, scope manquant, ou scope d’écriture (scans, workflows-write) absent
404	Ressource introuvable, ou projet hors de la clé (Projet introuvable)
413	Rapport de scan trop volumineux (20 Mo)
422	Paramètres ou rapport invalides
429	Limite d’appels API dépassée