Deployments

Create and monitor app deployments

List deployments

get

Returns a list of deployments for the specified app, ordered by most recent first.

Authorizations

AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters

appIdintegerRequired

The ID of the app

Query parameters

limitintegerOptional

Maximum number of deployments to return

Default: 20

statusstring · enumOptional

Filter by deployment status

Possible values:

Responses

200

List of deployments

application/json

401

Unauthorized

403

Insufficient scope

404

App not found

get/v1/apps/{appId}/deployments

GET /v1/apps/{appId}/deployments HTTP/1.1
Host: api.spice.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deployments": [
    {
      "id": 1,
      "status": "queued",
      "created_at": "2026-01-01T00:00:00.000Z",
      "started_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "image_tag": "text",
      "replicas": 1,
      "branch": "text",
      "commit_sha": "text",
      "commit_message": "text",
      "error_message": "text",
      "creation_source": "text",
      "created_by": "text"
    }
  ]
}

Create a deployment

post

Creates a new deployment for the specified app using its current spicepod configuration. The runtime image is selected based on the app's update channel.

Authorizations

AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters

appIdintegerRequired

The ID of the app

Body

image_tagstringOptional

Override the runtime image tag for this deployment

channelstring · enumOptional

Update channel that determines the runtime image

Possible values:

replicasinteger · min: 1 · max: 10Optional

Override the number of replicas for this deployment

branchstringOptional

Git branch name

commit_shastringOptional

Git commit SHA

commit_messagestringOptional

Git commit message

debugbooleanOptional

Enable debug mode for this deployment

Responses

202

Deployment created and queued for processing

application/json

idintegerOptional

Unique identifier for the deployment

statusstring · enumOptional

Current status of the deployment

Possible values:

created_atstring · date-timeOptional

Timestamp when the deployment was created

started_atstring · date-time · nullableOptional

Timestamp when the deployment started

updated_atstring · date-time · nullableOptional

Timestamp when the deployment was last updated

image_tagstring · nullableOptional

Runtime image tag used for this deployment

replicasintegerOptional

Number of replicas

branchstring · nullableOptional

Git branch name

commit_shastring · nullableOptional

Git commit SHA

commit_messagestring · nullableOptional

Git commit message

error_messagestring · nullableOptional

Error message if the deployment failed

creation_sourcestring · nullableOptional

Source that triggered the deployment

created_bystring · nullableOptional

User who created the deployment

400

Invalid request body or app has no spicepod configuration

401

Unauthorized

403

Insufficient scope

404

App not found

409

A deployment is already in progress for this app

422

Organization is not fully configured

500

Internal server error

502

Upstream service failure while provisioning the deployment

post/v1/apps/{appId}/deployments

POST /v1/apps/{appId}/deployments HTTP/1.1
Host: api.spice.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "image_tag": "text",
  "channel": "stable",
  "replicas": 1,
  "branch": "text",
  "commit_sha": "text",
  "commit_message": "text",
  "debug": true
}

{
  "id": 1,
  "status": "queued",
  "created_at": "2026-01-01T00:00:00.000Z",
  "started_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "image_tag": "text",
  "replicas": 1,
  "branch": "text",
  "commit_sha": "text",
  "commit_message": "text",
  "error_message": "text",
  "creation_source": "text",
  "created_by": "text"
}