Sign in
deploy

Create deployment

Creates a new deployment for a project using either a pre-built Docker image or build context.

Authentication: Requires a valid root key with appropriate permissions.

post/v2/deploy.createDeployment

Request body

OR

Example request

{
  "projectId": "proj_123abc",
  "keyspaceId": "key_abc123",
  "branch": "main",
  "environmentSlug": "production",
  "gitCommit": {
    "commitSha": "a1b2c3d4e5f6",
    "commitMessage": "feat: add new feature",
    "authorHandle": "johndoe",
    "authorAvatarUrl": "https://avatars.githubusercontent.com/u/123456",
    "timestamp": 1704067200000
  },
  "build": {
    "context": "s3://bucket/path/to/context.tar.gz",
    "dockerfile": "Dockerfile"
  }
}

Response

Deployment created successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "deploymentId": "dep_abc123xyz"
  }
}

Changes