API

Deployments API

Record a release, inspect its lifecycle, and provide a stable audit trail to the people who operate it.

EndpointPathDescription

POST/v1/projects/{project_id}/deployments

Create a deployment

GET/v1/deployments/{deployment_id}

Get deployment status

GET/v1/projects/{project_id}/deployments

List recent deployments

Use a service token in automation

Requests must include an Authorization header with a token scoped to deployments:write.

Parameters

Parameters	Description
project_idRequired	The project that owns this deployment.
environmentRequired	A named environment such as production.
versionOptional	Your immutable build or image reference.

Create a deployment

Request · json

POST /v1/projects/prj_atlas/deployments
Authorization: Bearer ns_live_••••
Content-Type: application/json

{
  "environment": "production",
  "version": "2026.08.18"
}

Response · json

HTTP/1.1 201 Created

{
  "id": "dep_01J6Q6R5",
  "status": "queued",
  "created_at": "2026-08-18T09:42:16Z"
}