Skip to content

API Reference Overview

The Nimbus API is a RESTful JSON API served over HTTPS.

  • Base URL: https://api.nimbus.example.com/v1
  • Format: JSON request/response bodies
  • Auth: Bearer token via the Authorization header (see Authentication)

Rate limits

Plan Requests / minute
Free 60
Pro 600
Enterprise Custom

Responses include rate-limit headers:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 599
X-RateLimit-Reset: 1750248000

Errors

Errors are returned with a non-2xx status code and a JSON body:

{
  "error": {
    "code": "not_found",
    "message": "Record 'hello-world' does not exist in bucket 'my-first-bucket'."
  }
}
Status Code Meaning
400 invalid_request Malformed request body or params
401 unauthorized Missing or invalid API key
404 not_found Resource does not exist
429 rate_limited Too many requests

See the reference pages for individual resources: