Product Overview

Nimbus Cloud is a developer platform for building, deploying, and scaling applications. Ship code from git push to global edge in under a minute.

One platform, every workload

Deploy services, functions, and static sites from a single pipeline. Autoscaling, rollbacks, and observability are built in — no YAML archaeology required.

Global edge network Zero-downtime deploys Built-in CI/CD

Quick Start

~5 minutes

Explore Documentation

Resources

Create Deployment

POST/v1/deployments

Creates a new deployment that ships a previously uploaded artifact to one or more environments. Deployments are asynchronous — poll the deployment resource or subscribe to webhooks for status updates.

Endpoints in this resource

Create Deployment

POST/v1/deployments

Creates a new deployment for the given artifact. The deployment starts in the queued state and progresses through building to live. A deployment must reference an artifact that belongs to the same project.

Request

Send a JSON body with Content-Type: application/json and a Bearer token in the Authorization header. Requests are limited to 100 calls per minute per project.

Parameters

Field	Type	Description
`project_id`required	string	ID of the project that owns the artifact.
`artifact_id`required	string	ID of a successfully uploaded artifact to deploy.
`environment`optional	string	Target environment. One of `staging` or `production`. Defaults to `staging`.

Responses

201Deployment created. Returns the full deployment object including its id and current status.
202Accepted when the platform defers the build. Poll GET /v1/deployments/{id} for progress.

Errors

400Malformed body or missing required fields.
401Missing or invalid API key.
404project_id or artifact_id not found.
503Platform temporarily unavailable — retry with backoff.

Examples

Ready-to-run snippets in cURL, JavaScript, and Python show the full request. Open them from the Try it panel.

Create Deployment — Examples

Call POST /v1/deployments from your language of choice. All snippets create a production deployment using placeholder IDs.

            
            create-deployment.sh
          
curl -X POST https://api.example.com/v1/deployments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id":   "YOUR_PROJECT_ID",
    "environment":  "production",
    "artifact_id":  "YOUR_ARTIFACT_ID"
  }'

            
            create-deployment.js
          
const res = await fetch("https://api.example.com/v1/deployments", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${YOUR_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    project_id: "YOUR_PROJECT_ID",
    environment: "production",
    artifact_id: "YOUR_ARTIFACT_ID",
  }),
});

const deployment = await res.json();

            
            create_deployment.py
          
import requests

res = requests.post(
  "https://api.example.com/v1/deployments",
  headers={"Authorization": f"Bearer {YOUR_API_KEY}"},
  json={
    "project_id": "YOUR_PROJECT_ID",
    "environment": "production",
    "artifact_id": "YOUR_ARTIFACT_ID",
  },
)
deployment = res.json()

Note: Replace the placeholder values — YOUR_API_KEY, YOUR_PROJECT_ID, and YOUR_ARTIFACT_ID — with your own credentials before running.