Using the API
Using the API The OrbitalCyber API gives your own scripts and tools what the console shows — vulnerabilities and where they're open, assets, endpoint agents, scans and connected cloud accounts — and can start scans. The full reference is OrbitalCyber API. Create an API key In the console, open Management → API keys and choose New API key (organization owners and administrators, or personal accounts). Pick only the scopes the integration needs: Scope Allows vulnerabilities:read Vulnerabilities and where they're open assets:read Assets (hosts, cloud resources, directory objects, endpoints) and their findings endpoints:read Endpoint agents and their software and patches scans:read Scans, their status and results scans:write Starting scans and running them again cloud_accounts:read Connected cloud accounts (AWS, Azure, Google Cloud, Microsoft 365) and what they assess cloud_scanners:read Our cloud scanners' egress addresses The key is shown once — store it as a secret. Keys can expire and can be revoked at any time. The API reference is also in the console, under API keys → API reference, with examples for your own server address. First request Use your OrbitalCyber address as the base URL and send the key as a bearer token. Lists and paging Lists take q (search), sort, dir (asc | desc), page (from 1) and limit (up to 200), and return {"rows": [...], "total": n}. Read every page: Start a scan and follow it Scans started through the API are checked exactly like scans started in the console. Scans on our cloud scanners need the ownership attestation (attest: true and the current attestation_version). Errors Errors are JSON {"error": "…"}: 401 for a missing or invalid key, 403 when the key lacks the scope or the plan doesn't include the feature, 404 for anything that doesn't exist or isn't your organization's. Clients The description is OpenAPI 3.1: download it from the reference (or from /api/v1/openapi.yaml on your server) to import into Postman or Insomnia, or to generate a client with OpenAPI Generator.
OrbitalCyber documentation