CloudAPI
Docs
v2.4
Clean, predictable REST endpoints, token-based authentication, and documentation written for engineers. Go from API key to first successful request in under five minutes.
# authenticate and fetch a resource
curl https://api.platform.dev/v2/orders \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"
→ 200 OK
{
"id": "ord_9f2a",
"status": "confirmed",
"latency_ms": 42
}Documentation
The Nimbus Cloud API gives you programmatic access to compute, storage, and data services through a single, consistent REST interface. Every resource speaks JSON over HTTPS, so you can provision infrastructure, manage data pipelines, and orchestrate services without leaving your existing tooling.
The API is designed for predictability: stable resource naming, explicit versioning, and consistent error semantics across every endpoint. Whether you're automating a single workflow or building a full integration layer, the same primitives apply everywhere.
Unified REST interface
One consistent request/response model across every service.
Real-time webhooks
Subscribe to resource events instead of polling for state.
Fine-grained access control
Scope API keys down to specific resources and actions.
Global edge availability
Low-latency routing across regional points of presence.
Usage-based billing
Transparent quotas and metered pricing per project.
Versioned releases
Backward-compatible changes with a clear deprecation policy.
curl https://api.nimbus.dev/v1/status \
-H "Authorization: Bearer YOUR_API_KEY"Need common gotchas or troubleshooting tips? Check the FAQ.
Every call to the API must be authenticated using a bearer token or API key. Requests without valid credentials are rejected with a 401 Unauthorized response.
Every account is issued a secret API key from the dashboard. This key is used directly as a bearer token, or optionally as an API key header, depending on the client you're integrating. Both methods authenticate the same underlying identity and permissions.
Bearer token
Recommended for server-to-server calls and most SDK-free integrations.
API key header
Alternative for tooling or environments that expect a custom header name.
Attach your credential to every request using one of the following headers.
Authorization: Bearer <API_KEY>
X-API-Key: <API_KEY>
Never expose API keys in client-side code, mobile apps, or public repositories.
All requests must be made over HTTPS. Unencrypted requests are rejected.
Rotate keys periodically and revoke unused ones from the dashboard immediately.
Scope keys to the minimum permissions required for the integration.
# Fetch a list of resources
curl -X GET "https://api.example.com/v1/resources" \
-H "Authorization: Bearer sk_live_51Hc9f...redacted" \
-H "Content-Type: application/json"
# 200 OK
{ "data": [ ... ], "has_more": false }A representative set of endpoints for working with resources on the platform. Every response is JSON, every request is authenticated—see the full reference in the API explorer for the complete list.
Core CRUD operations for creating and managing resource objects.
/v1/resources
List all resources in your account, with support for pagination, filtering, and sorting.
curl -X GET https://api.example.com/v1/resources \
-H "Authorization: Bearer YOUR_API_KEY"/v1/resources/{id}
Retrieve a single resource by its unique identifier, including all associated metadata.
/v1/resources
Create a new resource by submitting a JSON payload describing its properties.
Operational endpoints for monitoring platform availability.
/v1/status
Check platform health and current operational status without authentication.
Practical answers for developers integrating the API — covering rate limits, authentication errors, versioning, sandbox access, and support channels.
Default limits are 100 requests/second on Standard plans and 500 requests/second on Enterprise plans. Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.
Exceeding the limit returns a 429 Too Many Requests response. Use exponential backoff and respect the Retry-After header. See the Endpoints reference for per-route limits.
The most common causes are a missing or malformed Authorization: Bearer header, an expired or revoked API key, or using a sandbox key against the production host.
Also check for client clock drift, which can invalidate signed requests. Full setup steps are in the Authentication section.
Versions are path-based, e.g. /v1/…. Breaking changes are shipped under a new version; non-breaking additions land in the current one.
Deprecated versions remain live for at least 12 months, with warnings sent via the Deprecation response header before sunset.
Yes. Use base URL https://sandbox.api.example.com with a test key prefixed sk_test_….
Sandbox data resets nightly, webhooks can be simulated on demand, and no requests incur billing or affect production resources.
Check the status page first for ongoing incidents, then reach the developer support team via the contact details in the footer or the community forum.
Enterprise plans include a dedicated support SLA with guaranteed first-response times.