API Documentation · v2.0

Ship integrations faster with the Cloud API

Everything you need to authenticate, call, and scale against our REST endpoints — clear references, no marketing fluff. Built for developers who want answers, not a tour.

Get Started Authentication Guide
request.sh 
# Authenticate and fetch a resource
curl -X GET https://api.platform.dev/v2/resources \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

200 OK · application/json

// 01 Overview

Understand the platform before you integrate

Nimbus API is a cloud platform that gives your applications programmatic access to compute, storage, and messaging primitives through a single, consistent REST interface. Every endpoint speaks JSON, follows predictable resource conventions, and returns structured errors so you spend less time guessing and more time shipping.

Key capabilities

Unified REST interface
One base URL, consistent resource naming, and predictable status codes across every service.
Real-time webhooks
Subscribe to resource events and receive signed payloads the moment state changes.
Global edge network
Requests are routed to the nearest region automatically, keeping latency low worldwide.
Usage-based billing
Pay only for the requests and resources you consume, tracked in real time on your dashboard.

Common use cases

  • Automating internal workflows and back-office tasks
  • Building customer-facing product integrations
  • Powering mobile and web apps at scale
  • Syncing data between third-party services

Getting started

  1. 1

    Create an account and generate an API key from your dashboard.

  2. 2

    Authenticate your requests with a Bearer token in the header.

  3. 3

    Call your first endpoint and inspect the JSON response.

request 200 OK 
curl https://api.nimbuscloud.dev/v1/status \
  -H "Authorization: Bearer YOUR_API_KEY"
Authentication guide → Browse endpoints

Have a specific question? Check the FAQ section for quick answers on rate limits, SDKs, and billing.

API Reference

Endpoints

Core resource groups exposed by the API. Every endpoint accepts and returns JSON, follows REST conventions, and requires the bearer token described in Authentication.

Users

/v1/users

Create, retrieve, and manage user records tied to your organization.

  • GET/v1/usersList all users in your organization
  • GET/v1/users/{id}Retrieve a single user by ID
  • POST/v1/usersCreate a new user record
  • PUT/v1/users/{id}Update role or profile fields
View example \u2014 POST /v1/users

Request

POST /v1/users\n{\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\"\n}

Response \u00b7 201

{\n  \"id\": \"usr_8f2a1c\",\n  \"email\": \"[email protected]\",\n  \"role\": \"admin\",\n  \"created_at\": \"2026-07-08T10:15:00Z\"\n}

Projects

/v1/projects

Organize resources and credentials into isolated project workspaces.

  • GET/v1/projectsList projects in the current organization
  • POST/v1/projectsCreate a new project workspace
  • DELETE/v1/projects/{id}Permanently remove a project
View example \u2014 GET /v1/projects

Request

GET /v1/projects\nAuthorization: Bearer sk_live_...

Response \u00b7 200

{\n  \"data\": [\n    { \"id\": \"proj_3n9k2\", \"name\": \"Payments Service\", \"status\": \"active\" },\n    { \"id\": \"proj_7h1lm\", \"name\": \"Mobile Backend\", \"status\": \"active\" }\n  ],\n  \"has_more\": false\n}

Usage Metrics

/v1/usage

Query request volume, error rates, and latency across projects.

  • GET/v1/usageAggregate usage across all projects
  • GET/v1/usage/{project_id}/summaryPer-project request and error summary
  • GET/v1/usage/{project_id}/timeseriesTime-bucketed request volume
View example \u2014 GET /v1/usage/{project_id}/summary

Request

GET /v1/usage/proj_3n9k2/summary\nAuthorization: Bearer sk_live_...

Response \u00b7 200

{\n  \"project_id\": \"proj_3n9k2\",\n  \"period\": \"2026-06\",\n  \"requests\": 128430,\n  \"errors\": 214,\n  \"p95_latency_ms\": 182\n}
FAQ

Frequently asked questions

Common questions from developers integrating with the API — covering rate limits, auth errors, versioning, sandbox access, and debugging.

Still stuck?

Check the Authentication and Endpoints docs, or reach the team directly.

Contact support
What are the API rate limits?

Standard plans are capped at 120 requests/min per API key. Current usage is returned on every response via X-RateLimit-Limit and X-RateLimit-Remaining headers. Exceeding the limit returns a 429 status with a Retry-After header indicating when to resume.

Why am I getting authentication failures?

A 401 usually means a missing or malformed Authorization: Bearer <token> header, while a 403 means the key is valid but lacks permission for the resource. Expired tokens and client clock drift over 5 minutes are the most common culprits — see the Authentication section for token lifetimes.

How does API versioning work?

Every endpoint is namespaced by major version in the URL path, e.g. /v1/. Breaking changes ship under a new version; non-breaking additions land in the current one. Deprecated versions stay live for a minimum of 12 months — see Endpoints for the current version map.

Is there a sandbox or testing environment?

Yes. Use test keys prefixed with sk_test_ against sandbox.api.example.com. Sandbox requests never touch production data or billing, and rate limits are relaxed to 600 requests/min to make iteration easier.

How do I get support or debug a failed request?

Every response includes a unique X-Request-Id header — include it when contacting support so we can trace the exact call. Error bodies follow a consistent { code, message } shape. For live incidents, check the status page before opening a ticket.

Can I request a higher rate limit for production?

Yes — production limits scale with usage tier. Contact support with your expected traffic pattern and current X-RateLimit-Limit to request an increase; most upgrades are applied within one business day.