Skip to main content

API reference

NimbusWiz is a UI prototype with no application logic yet. This section is a design artifact of possible REST APIs that NimbusWiz would ship for an engineering team.

How this section would extend for a real product​

Pages to include in API reference:

  1. Authentication and key management: Bearer tokens, scope model
  2. Error envelope and taxonomy: one error code list and mapping table
  3. Pagination and response envelopes: one pattern, applied everywhere
  4. Idempotency and retry semantics: required for any state-changing endpoint
  5. Webhooks, with signature verification: optional, but expected at enterprise scale
  6. A quickstart that walks one happy-path scenario end to end

This section currently documents the following two endpoints in full to demonstrate the process.

info

Design spec, not a live endpoint

api.nimbuswiz.io is not callable. Every URL, schema, and status code is a design proposal grounded in the prototype's UI.

EndpointPatternWhy this one
Register a systemPOST https://api.nimbuswiz.io/v1/fleet
Synchronous create with validation		The first call any integration would make. Maps directly to the registration wizard in the prototype.
Get system metricsGET https://api.nimbuswiz.io/v1/fleet/:system_id/metrics
Time-bounded read with query parameters		Covers the read-side patterns: filters, ranges, response envelopes.

Other endpoints such as scan, deployment, and rollback follow the same conventions.