Get Deployment

GET

/api/v1/deployments/{deployment_id}

curl --request GET \
  --url https://example.com/api/v1/deployments/example

Get deployment status and file details.

Parameters

Path Parameters

deployment_id

required

Deployment Id

string

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

DeploymentStatusResponse

Complete deployment status with file details.

object

deployment

required

DeploymentResponse

Deployment information

object

id

required

Id

Deployment ID

string

git_repository

required

Git Repository

Git repository name

string

branch

required

Branch

Git branch

string

commit_sha

Any of:

string

string

null

null

status

required

DeploymentStatus

Deployment status

string

Allowed values: pending running success failed partial_success cancelled

file_pattern

Any of:

string

string

null

null

variables

Any of:

object

object

key

additional properties

Any of:

string

string

integer

integer

number

number

boolean

boolean

null

null

on_error

required

On Error

Error handling behavior

string

description

Any of:

string

string

null

null

created_at

required

Created At

Creation timestamp

string format: date-time

started_at

Any of:

string

string format: date-time

null

null

completed_at

Any of:

string

string format: date-time

null

null

created_by

Any of:

string

string

null

null

files

required

Files

File deployment details

Array<object>

DeploymentFileDetail

Individual file deployment detail.

object

id

required

Id

Detail record ID

string

file_path

required

File Path

Relative file path in repository

string

file_type

required

FileType

Type of file

string

Allowed values: sql_ddl sql_dml procedure function task stream dynamic_table snowpark other

git_status

required

GitStatus

Git change status

string

Allowed values: added modified removed renamed

deployment_status

required

FileStatus

Deployment status

string

Allowed values: pending in_progress success failed skipped

error_message

Any of:

string

string

null

null

execution_order

required

Execution Order

Order of execution

integer

deployed_at

Any of:

string

string format: date-time

null

null

stats

required

Stats

Deployment statistics

object

key

additional properties

integer

Example

{
  "deployment": {
    "status": "pending"
  },
  "files": [
    {
      "file_type": "sql_ddl",
      "git_status": "added",
      "deployment_status": "pending"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}