REST API

The REST API backs the CLI and dashboard, and is available for your own tooling. All requests require an Authorization: Bearer <api-key> header.

Base URL: https://api.nimbus.dev/v1

GET /projects

List projects in your account.

curl

curl https://api.nimbus.dev/v1/projects \
  -H "Authorization: Bearer $NIMBUS_API_KEY"

JavaScript

const res = await fetch('https://api.nimbus.dev/v1/projects', {
  headers: { Authorization: `Bearer ${process.env.NIMBUS_API_KEY}` },
});
const projects = await res.json();

Python

import requests

res = requests.get(
    "https://api.nimbus.dev/v1/projects",
    headers={"Authorization": f"Bearer {api_key}"},
)
projects = res.json()

POST /projects/:id/deployments

Trigger a deployment from a tarball or git ref.

curl

curl -X POST https://api.nimbus.dev/v1/projects/prj_123/deployments \
  -H "Authorization: Bearer $NIMBUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ref": "main", "env": "production"}'

JavaScript

await fetch('https://api.nimbus.dev/v1/projects/prj_123/deployments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.NIMBUS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ ref: 'main', env: 'production' }),
});

DELETE /projects/:id

Permanently delete a project and all of its deployments.

curl -X DELETE https://api.nimbus.dev/v1/projects/prj_123 \
  -H "Authorization: Bearer $NIMBUS_API_KEY"

Danger

This immediately tears down the project in every region. There’s no confirmation step and no undo.

Rate limits

Requests are limited to 600 per minute per API key. Responses include the usual X-RateLimit-* headers so you can back off before hitting 429.