Skip to main content

API Introduction

The public docs API surface is easiest to understand if you split it into three layers:
  • Authentication
  • Resource IDs you already know from the app or CLI
  • Workflow endpoints that create scans or fetch findings

Base Pattern

Most endpoints in the product follow this shape: /api/v1/organizations/:orgId/... For scan workflows, the main resources are:
  • Repository IDs
  • Cloud integration IDs
  • Scan or analysis IDs returned by create or list calls

Response Shape

Cloudgeni routes generally use a success envelope:
{
  "success": true,
  "data": {}
}
Error responses follow the same pattern with success: false, an error code, and a message.

The Endpoints Most Teams Use First

  • Repository static analysis
  • Repository IaC scans
  • Cloud infra scans
  • Findings retrieval for the created scan
Use Authentication for the header format, then Scanning API for the actual endpoint shapes.