Aller au contenu principal
Référence API

L’API Cloudios

FinOps multi-cloud (AWS, GCP, Azure) + Kubernetes pod-level + détection d’anomalies ML. Spec OpenAPI 3.1, authentification Clerk Bearer, prête pour vos intégrations.

Compatible Postman, Insomnia et openapi-generator (SDK TypeScript, Python, Go).

Démarrage

Authentification et premier appel

Trois modes d’auth : clés API scopées (machine-to-machine), session Clerk (routes du dashboard), signature HMAC (webhooks). Tout passe par l’en-tête Authorization.

Clés API

Créez une clé dans Dashboard → Settings → API keys : secret ck_live_* affiché une seule fois, scopes par clé (scan:read, findings:read…), révocable à tout moment. Passez-la en Bearer sur les routes /api/public/v1/*.

curl https://trycloudios.com/api/public/v1/findings \
  -H "Authorization: Bearer ck_live_xxxxxxxxxxxx"

Lancer un scan

Route session (token Clerk de votre session dashboard). Renvoie un scan_id et un job_id immédiatement ; sondez /api/scan/{scan_id} jusqu’à complétion. Les webhooks (ingestion K8s, Slack) utilisent une signature HMAC dédiée.

curl -X POST https://trycloudios.com/api/scan \
  -H "Authorization: Bearer <clerk_session_token>" \
  -H "Content-Type: application/json" \
  -d '{ "aws_account_id": "uuid", "scan_tier": "standard" }'
https://trycloudios.comproductionhttp://localhost:3000développement local
Endpoints

Référence des endpoints

Le contrat complet — paramètres, schémas de body et codes de réponse — vit dans la spec OpenAPI.

Public API

Lecture machine-to-machine via clés API scopées (ck_live_*).
GET/api/public/v1/scansLister les scans récents + résumé (scope scan:read).API KEY
GET/api/public/v1/findingsLister les findings vérifiés (scope findings:read).API KEY

Scans

Déclencher et suivre des scans de coûts.
POST/api/scanLancer un scan complet (renvoie un job_id immédiatement).
GET/api/scan/{scan_id}État et résultats d’un scan.

Clusters

Enregistrement Kubernetes + ingestion de métriques pod-level.
GET/api/clustersLister vos clusters.
POST/api/clustersEnregistrer un cluster (token affiché une seule fois).
GET/api/clusters/{id}Détail d’un cluster.
DELETE/api/clusters/{id}Déconnecter un cluster (cascade des métriques).
GET/api/clusters/{id}/podsMétriques pod-level (namespace, hours, limit).
POST/api/clusters/ingestPush de l’agent Helm — auth HMAC (pas Clerk).HMAC

Terraform

Analyse de coût pré-déploiement.
POST/api/terraform/analyzeAnalyser le coût d’un plan Terraform.
POST/api/terraform/pr-commentAnalyser et commenter une PR GitHub.

Jobs

Administration de la file asynchrone (DLQ, annulation, replay).
GET/api/jobs/dead-letterLister les jobs en dead-letter.
POST/api/jobs/dead-letterRejouer un job DLQ.
GET/api/jobs/{id}État d’un job.
DELETE/api/jobs/{id}Annuler un job en file ou en cours.

CloudFormation

État des stacks via STS AssumeRole.
GET/api/aws-accounts/cfn-statusÉtat d’une stack CloudFormation.

Anomalies

Streaming temps réel des anomalies (SSE).
GET/api/anomalies/streamFlux SSE — à écouter via EventSource.

Slack

Webhook de slash command Slack.
POST/api/slack/commandsCommande /cloudios — signature HMAC SHA-256 v0.HMAC

Cost Allocation

Allocation par tag cross-cloud (différenciateur Tier 4).
GET/api/cost-allocation/tagsAgréger les findings AWS+GCP+Azure+OCI+K8s par tag.

Migration ROI

Simulateur de ROI de migration cross-cloud (Tier 4).
POST/api/migration-roiDelta de coût + payback pour AWS↔GCP↔Azure↔OCI.

Prêt à intégrer Cloudios ?

Importez la spec OpenAPI dans votre outil favori ou générez un SDK typé en quelques secondes.