Deployments API

View your organization's history of deployments to your environments.

List deployments in an organization

List all of the deployments for an organization.

Query Parameters

status

The status of the deployments to list.

after

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit

The maximum number of results to return. Must be between 1 and 240.

sort_by

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at.

Responses

200

OK response.

data

An array of results.

Show attributes

created_at

The time the deployment was created.

data

Describes the metadata for a deployment.

Show attributes

patch

The patch of the deployment.

Show attributes

from

The path the operation is from.

old_value

The old value of the operation.

The type of the operation. One of add, replace, remove, move, copy, test.

path

The path of the operation.

value

The value of the operation.

source

Describes the source of a deployment.

Show attributes

git

Describes the git source of a deployment.

Show attributes

commit

Show attributes

author

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

committer

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

message

The message of the git commit.

sha

The SHA of the git commit.

installation_id

The installation ID of the git provider.

owner

The owner of the git repository.

provider

The git provider. One of github.

pull_request

The ID of the pull request.

ref

The tag or branch of the git repository.

repo

The name of the git repository.

repo_id

The ID of the git repository.

registry

Describes the registry source of a deployment.

Show attributes

command

The command of the registry.

image

The image of the registry.

stacks

The state of the stacks at the time of deployment status change.

Show attributes

The ID of the stack. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

status

The status of the stack. One of PENDING, CREATE_COMPLETE, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS, REVIEW_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED, ROLLBACK_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_ROLLBACK_COMPLETE, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_IN_PROGRESS, IMPORT_COMPLETE, IMPORT_ROLLBACK_IN_PROGRESS, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_COMPLETE.

status_reason

The reason for the stack's status.

timestamp

The timestamp of the stack's last update at its cloud provider.

environment_id

The ID of the environment the deployment belongs to. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

finished_at

The time the deployment finished.

The ID of the deployment. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

stack_ids

The IDS of stacks included in the deployment.

started_at

The time the deployment started.

status

The status of the deployment. One of pending, pending_approval, in_progress, succeeded, failed, failed_with_action_required.

updated_at

The time the deployment was last updated.

has_more

Whether there are more results available.

next_page

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400

Bad Request response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

401

Unauthorized response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

403

Forbidden response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

404

Not Found response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

408

Request Timeout response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

409

Conflict response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

429

Too Many Requests response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

500

Internal Server Error response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

501

Not Implemented response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

Get a deployment

Get a deployment by its ID.

Path Parameters

The ID of the deployment to get.

Responses

200

OK response.

created_at

The time the deployment was created.

data

Describes the metadata for a deployment.

Show attributes

patch

The patch of the deployment.

Show attributes

from

The path the operation is from.

old_value

The old value of the operation.

The type of the operation. One of add, replace, remove, move, copy, test.

path

The path of the operation.

value

The value of the operation.

source

Describes the source of a deployment.

Show attributes

git

Describes the git source of a deployment.

Show attributes

commit

Show attributes

author

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

committer

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

message

The message of the git commit.

sha

The SHA of the git commit.

installation_id

The installation ID of the git provider.

owner

The owner of the git repository.

provider

The git provider. One of github.

pull_request

The ID of the pull request.

ref

The tag or branch of the git repository.

repo

The name of the git repository.

repo_id

The ID of the git repository.

registry

Describes the registry source of a deployment.

Show attributes

command

The command of the registry.

image

The image of the registry.

stacks

The state of the stacks at the time of deployment status change.

Show attributes

The ID of the stack. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

status

status_reason

The reason for the stack's status.

timestamp

The timestamp of the stack's last update at its cloud provider.

environment_id

finished_at

The time the deployment finished.

stack_ids

The IDS of stacks included in the deployment.

started_at

The time the deployment started.

status

The status of the deployment. One of pending, pending_approval, in_progress, succeeded, failed, failed_with_action_required.

updated_at

The time the deployment was last updated.

400

Bad Request response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

401

Unauthorized response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

403

Forbidden response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

404

Not Found response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

408

Request Timeout response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

409

Conflict response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

429

Too Many Requests response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

500

Internal Server Error response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

501

Not Implemented response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

List deployments for a stack

List all of the deployments for a stack.

Path Parameters

stack_id

The stack ID to list deployments for.

Query Parameters

status

The status of the deployments to list.

after

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit

The maximum number of results to return. Must be between 1 and 240.

sort_by

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at.

Responses

200

OK response.

data

An array of results.

Show attributes

created_at

The time the deployment was created.

data

Describes the metadata for a deployment.

Show attributes

patch

The patch of the deployment.

Show attributes

from

The path the operation is from.

old_value

The old value of the operation.

The type of the operation. One of add, replace, remove, move, copy, test.

path

The path of the operation.

value

The value of the operation.

source

Describes the source of a deployment.

Show attributes

git

Describes the git source of a deployment.

Show attributes

commit

Show attributes

author

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

committer

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

message

The message of the git commit.

sha

The SHA of the git commit.

installation_id

The installation ID of the git provider.

owner

The owner of the git repository.

provider

The git provider. One of github.

pull_request

The ID of the pull request.

ref

The tag or branch of the git repository.

repo

The name of the git repository.

repo_id

The ID of the git repository.

registry

Describes the registry source of a deployment.

Show attributes

command

The command of the registry.

image

The image of the registry.

stacks

The state of the stacks at the time of deployment status change.

Show attributes

The ID of the stack. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

status

status_reason

The reason for the stack's status.

timestamp

The timestamp of the stack's last update at its cloud provider.

environment_id

finished_at

The time the deployment finished.

stack_ids

The IDS of stacks included in the deployment.

started_at

The time the deployment started.

status

The status of the deployment. One of pending, pending_approval, in_progress, succeeded, failed, failed_with_action_required.

updated_at

The time the deployment was last updated.

has_more

Whether there are more results available.

next_page

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400

Bad Request response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

401

Unauthorized response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

403

Forbidden response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

404

Not Found response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

408

Request Timeout response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

409

Conflict response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

429

Too Many Requests response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

500

Internal Server Error response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

501

Not Implemented response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

List deployments in an environment

List all of the deployments for an environment.

Path Parameters

environment_id

The environment ID to scope the deployments to. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Query Parameters

status

The status of the deployments to list.

after

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit

The maximum number of results to return. Must be between 1 and 240.

sort_by

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at.

Responses

200

OK response.

data

An array of results.

Show attributes

created_at

The time the deployment was created.

data

Describes the metadata for a deployment.

Show attributes

patch

The patch of the deployment.

Show attributes

from

The path the operation is from.

old_value

The old value of the operation.

The type of the operation. One of add, replace, remove, move, copy, test.

path

The path of the operation.

value

The value of the operation.

source

Describes the source of a deployment.

Show attributes

git

Describes the git source of a deployment.

Show attributes

commit

Show attributes

author

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

committer

Show attributes

The email of the git commit author.

The ID of the git commit author.

The login of the git commit author.

name

The name of the git commit author.

message

The message of the git commit.

sha

The SHA of the git commit.

installation_id

The installation ID of the git provider.

owner

The owner of the git repository.

provider

The git provider. One of github.

pull_request

The ID of the pull request.

ref

The tag or branch of the git repository.

repo

The name of the git repository.

repo_id

The ID of the git repository.

registry

Describes the registry source of a deployment.

Show attributes

command

The command of the registry.

image

The image of the registry.

stacks

The state of the stacks at the time of deployment status change.

Show attributes

The ID of the stack. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

status

status_reason

The reason for the stack's status.

timestamp

The timestamp of the stack's last update at its cloud provider.

environment_id

finished_at

The time the deployment finished.

stack_ids

The IDS of stacks included in the deployment.

started_at

The time the deployment started.

status

The status of the deployment. One of pending, pending_approval, in_progress, succeeded, failed, failed_with_action_required.

updated_at

The time the deployment was last updated.

has_more

Whether there are more results available.

next_page

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400

Bad Request response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

401

Unauthorized response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

403

Forbidden response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

404

Not Found response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

408

Request Timeout response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

409

Conflict response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

429

Too Many Requests response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

500

Internal Server Error response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

501

Not Implemented response.

cause

The cause of the error.

code

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message

The message of the error.

API Reference

Explore the API reference by resource type