SPspice
Deployments

Get a deployment

Returns a single deployment for the specified project. The body matches one item from GET /v1/projects/{projectId}/deployments. Not cacheable. Poll this path for stored status after POST create.

get/v1/projects/{projectId}/deployments/{deploymentId}

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

projectIdinteger required

The ID of the project

deploymentIdinteger required

The ID of the deployment

Headers

X-Org-Namestring

The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

Response

Deployment

idinteger

Unique identifier for the deployment

status'queued' | 'in_progress' | 'succeeded' | 'failed' | 'created'

Current status of the deployment

created_atstring date-time

Timestamp when the deployment was created

updated_atstring date-time nullable

Timestamp when the deployment was last updated

image_tagstring nullable

Runtime image tag used for this deployment

replicasinteger

Number of replicas

branchstring nullable

Git branch name

commit_shastring nullable

Git commit SHA

commit_messagestring nullable

Git commit message

error_codestring nullable

Set with error_message on failed and on in_progress while Cloud is retrying a scheduling block. Null on succeeded, on ordinary waiting in_progress, and on writers that predated this column. Older failed rows may still have a message with a null code.

error_messagestring nullable

Catalog copy for the current error_code. Older failed rows may still have a message with a null error_code.

creation_sourcestring nullable

Source that triggered the deployment

created_byinteger nullable

User ID who created the deployment

Changes

No recorded changes to this operation across all 1 revision of this API.