Nimbus API Documentation

Integrate quickly with a reliable cloud API platform.

Reference REST endpoints, authentication workflows, and implementation guidance built for production teams.

request example

200 OK

POST /v1/events
Authorization: Bearer <api_key>
Content-Type: application/json

{
  "type": "build.completed",
  "source": "ci.pipeline",
  "payload": {
    "id": "evt_9f82"
  }
}

Overview

Nimbus API provides predictable REST endpoints, JSON responses, and straightforward integration patterns so engineering teams can ship reliable integrations without custom protocol handling.

Key capabilities

Resource-oriented endpoints
Stable resource paths and object-focused operations across the API surface.
Standard HTTP methods
Consistent use of GET, POST, PUT, PATCH, and DELETE.
Versioned API access
Explicit versioning keeps integrations backward-compatible during platform updates.
Consistent error handling
Uniform status codes and structured error payloads simplify retries, logging, and debugging.

Security

Authentication

All API requests require credentials sent through HTTP headers. Keep keys secret, use server-side storage, and avoid embedding secrets in client code. For request examples, continue to Endpoints.

Quick steps

1 Generate an API key and API secret in your project settings.
2 Include both credentials in request headers on every authenticated call.
3 Test with a simple authenticated request before integrating full workflows.
4 Rotate secrets periodically and immediately after any suspected exposure.

Header example

HTTP

GET /v1/resources HTTP/1.1
Host: api.example.com
X-API-Key: your_api_key
X-API-Secret: your_api_secret

API Reference

Endpoints

Core REST resources for project management. All examples below use versioned routes and standard HTTP semantics.

Method Route + Description

GET

/v1/projects

List all projects available to the authenticated account. Supports pagination via query parameters.

POST

/v1/projects

Create a new project. Requires a JSON request body with project metadata and returns the created project resource.

GET

/v1/projects/{id}

Fetch a single project by identifier. Returns full project details when the resource exists and is accessible.

DELETE

/v1/projects/{id}

Permanently remove a project by identifier. Returns a success status with no resource body on completion.

Payload format

Request and response payloads are JSON (Content-Type: application/json). Use UTF-8 encoding and ensure property names match the documented schema.

Example request body

{
  "name": "alpha-service",
  "environment": "production"
}

Example response body

{
  "id": "prj_12345",
  "name": "alpha-service",
  "status": "active"
}

Support

Frequently Asked Questions

Practical implementation details for common integration questions. Answers are intentionally concise and reference the relevant documentation sections.

What are the API rate limits?

Production keys default to 120 requests/minute per project, with burst allowance up to 2x for short intervals. Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and Retry-After headers.

How does API versioning work?

Versioning is explicit in the path (for example, /v1/...). Minor, backward-compatible changes are released without path changes; breaking changes are introduced in a new major version. Deprecation notices are published at least 90 days before retirement.

What do error responses look like?

Errors return standard HTTP status codes plus a structured JSON body: {"error":{"code":"invalid_request","message":"...","request_id":"..."}}. Treat 5xx as retryable with exponential backoff; resolve 4xx by correcting the request.

Is there a sandbox or test environment?

Yes. Use sandbox credentials to call the same endpoints against the sandbox base URL. Data is isolated, deterministic for test scenarios, and rate limits are lower than production. Do not use sandbox tokens in production workloads.

Where can I find authentication details?

See the Authentication section for token formats, required headers, and rotation guidance. For endpoint-specific requirements, check the Endpoints section.