Skip to main content

API Overview

The NimbusGuard Platform exposes a REST API. Interactive Swagger docs are available at /docs on a running Platform instance.

Authentication​

There are two types of principal:

  • Human users — log in with email + password to receive a short-lived JWT plus a rotating refresh token.
  • Service accounts — authenticate with an API key (nbg_...) sent in the X-API-Key header.

Endpoint groups​

Auth, SSO (SAML), Dashboard, Organizations, Users/Roles, Service Accounts, Cloud Accounts/Organizations, Resources, Findings, and Custom Controls.

:::warning Placeholder ⚠️ Generate this section from the OpenAPI spec: per-endpoint request/response schemas, auth requirements, and examples. Consider embedding the OpenAPI file. :::