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.

get
/ v1 / deployments 
curl --request GET \
     --url https://api.flexstack.com/v1/deployments \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Query Parameters

status
array (string)

The status of the deployments to list.

after
string

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

limit
integer (int64)

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

sort_by
enum

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
array (object)
required

An array of results.

Show attributes
created_at
string (date-time)
required

The time the deployment was created.

data
object
required

Describes the metadata for a deployment.

Show attributes
patch
array (object)
required

The patch of the deployment.

Show attributes
from
string

The path the operation is from.

old_value
unknown

The old value of the operation.

op
enum
required

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

path
string
required

The path of the operation.

value
unknown

The value of the operation.

source
object

Describes the source of a deployment.

Show attributes
git
object

Describes the git source of a deployment.

Show attributes
commit
object
required
Show attributes
author
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

committer
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

message
string
required

The message of the git commit.

sha
string
required

The SHA of the git commit.

installation_id
string
required

The installation ID of the git provider.

owner
string
required

The owner of the git repository.

provider
enum
required

The git provider. One of github.

pull_request
string

The ID of the pull request.

ref
string
required

The tag or branch of the git repository.

repo
string
required

The name of the git repository.

repo_id
string
required

The ID of the git repository.

registry
object

Describes the registry source of a deployment.

Show attributes
command
array (string)

The command of the registry.

image
string
required

The image of the registry.

stacks
array (object)

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

Show attributes
id
string
required

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
enum
required

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
string

The reason for the stack's status.

timestamp
string (date-time)
required

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

environment_id
string
required

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
string (date-time)

The time the deployment finished.

id
string
required

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
array (string)
required

The IDS of stacks included in the deployment.

started_at
string (date-time)

The time the deployment started.

status
enum
required

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

updated_at
string (date-time)
required

The time the deployment was last updated.

has_more
boolean
required

Whether there are more results available.

next_page
string

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
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

Get a deployment

Get a deployment by its ID.

get
/ v1 / deployments / :id
get
/ v1 / environments / :environment_id / deployments / :id 
curl --request GET \
     --url https://api.flexstack.com/v1/deployments/Voluptates%20impedit%20repellendus%20laborum. \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The ID of the deployment to get.

Responses

200
OK response.
created_at
string (date-time)
required

The time the deployment was created.

data
object
required

Describes the metadata for a deployment.

Show attributes
patch
array (object)
required

The patch of the deployment.

Show attributes
from
string

The path the operation is from.

old_value
unknown

The old value of the operation.

op
enum
required

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

path
string
required

The path of the operation.

value
unknown

The value of the operation.

source
object

Describes the source of a deployment.

Show attributes
git
object

Describes the git source of a deployment.

Show attributes
commit
object
required
Show attributes
author
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

committer
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

message
string
required

The message of the git commit.

sha
string
required

The SHA of the git commit.

installation_id
string
required

The installation ID of the git provider.

owner
string
required

The owner of the git repository.

provider
enum
required

The git provider. One of github.

pull_request
string

The ID of the pull request.

ref
string
required

The tag or branch of the git repository.

repo
string
required

The name of the git repository.

repo_id
string
required

The ID of the git repository.

registry
object

Describes the registry source of a deployment.

Show attributes
command
array (string)

The command of the registry.

image
string
required

The image of the registry.

stacks
array (object)

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

Show attributes
id
string
required

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
enum
required

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
string

The reason for the stack's status.

timestamp
string (date-time)
required

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

environment_id
string
required

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
string (date-time)

The time the deployment finished.

id
string
required

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
array (string)
required

The IDS of stacks included in the deployment.

started_at
string (date-time)

The time the deployment started.

status
enum
required

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

updated_at
string (date-time)
required

The time the deployment was last updated.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

Cancel a deployment

Cancel a deployment by its ID.

patch
/ v1 / deployments / :id / cancel 
curl --request PATCH \
     --url https://api.flexstack.com/v1/deployments/Omnis%20autem%20accusantium%20provident%20ut%20sunt./cancel \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The ID of the deployment to cancel.

Responses

200
OK response.
created_at
string (date-time)
required

The time the deployment was created.

data
object
required

Describes the metadata for a deployment.

Show attributes
patch
array (object)
required

The patch of the deployment.

Show attributes
from
string

The path the operation is from.

old_value
unknown

The old value of the operation.

op
enum
required

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

path
string
required

The path of the operation.

value
unknown

The value of the operation.

source
object

Describes the source of a deployment.

Show attributes
git
object

Describes the git source of a deployment.

Show attributes
commit
object
required
Show attributes
author
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

committer
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

message
string
required

The message of the git commit.

sha
string
required

The SHA of the git commit.

installation_id
string
required

The installation ID of the git provider.

owner
string
required

The owner of the git repository.

provider
enum
required

The git provider. One of github.

pull_request
string

The ID of the pull request.

ref
string
required

The tag or branch of the git repository.

repo
string
required

The name of the git repository.

repo_id
string
required

The ID of the git repository.

registry
object

Describes the registry source of a deployment.

Show attributes
command
array (string)

The command of the registry.

image
string
required

The image of the registry.

stacks
array (object)

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

Show attributes
id
string
required

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
enum
required

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
string

The reason for the stack's status.

timestamp
string (date-time)
required

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

environment_id
string
required

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
string (date-time)

The time the deployment finished.

id
string
required

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
array (string)
required

The IDS of stacks included in the deployment.

started_at
string (date-time)

The time the deployment started.

status
enum
required

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

updated_at
string (date-time)
required

The time the deployment was last updated.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

List deployments for a stack

List all of the deployments for a stack.

get
/ v1 / stacks / :stack_id / deployments 
curl --request GET \
     --url https://api.flexstack.com/v1/stacks/Velit%20quae%20fugit./deployments \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

stack_id
string
required

The stack ID to list deployments for.

Query Parameters

status
array (string)

The status of the deployments to list.

after
string

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

limit
integer (int64)

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

sort_by
enum

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
array (object)
required

An array of results.

Show attributes
created_at
string (date-time)
required

The time the deployment was created.

data
object
required

Describes the metadata for a deployment.

Show attributes
patch
array (object)
required

The patch of the deployment.

Show attributes
from
string

The path the operation is from.

old_value
unknown

The old value of the operation.

op
enum
required

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

path
string
required

The path of the operation.

value
unknown

The value of the operation.

source
object

Describes the source of a deployment.

Show attributes
git
object

Describes the git source of a deployment.

Show attributes
commit
object
required
Show attributes
author
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

committer
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

message
string
required

The message of the git commit.

sha
string
required

The SHA of the git commit.

installation_id
string
required

The installation ID of the git provider.

owner
string
required

The owner of the git repository.

provider
enum
required

The git provider. One of github.

pull_request
string

The ID of the pull request.

ref
string
required

The tag or branch of the git repository.

repo
string
required

The name of the git repository.

repo_id
string
required

The ID of the git repository.

registry
object

Describes the registry source of a deployment.

Show attributes
command
array (string)

The command of the registry.

image
string
required

The image of the registry.

stacks
array (object)

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

Show attributes
id
string
required

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
enum
required

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
string

The reason for the stack's status.

timestamp
string (date-time)
required

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

environment_id
string
required

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
string (date-time)

The time the deployment finished.

id
string
required

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
array (string)
required

The IDS of stacks included in the deployment.

started_at
string (date-time)

The time the deployment started.

status
enum
required

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

updated_at
string (date-time)
required

The time the deployment was last updated.

has_more
boolean
required

Whether there are more results available.

next_page
string

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
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

List deployments in an environment

List all of the deployments for an environment.

get
/ v1 / environments / :environment_id / deployments 
curl --request GET \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/deployments \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

environment_id
string
required

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
array (string)

The status of the deployments to list.

after
string

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

limit
integer (int64)

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

sort_by
enum

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
array (object)
required

An array of results.

Show attributes
created_at
string (date-time)
required

The time the deployment was created.

data
object
required

Describes the metadata for a deployment.

Show attributes
patch
array (object)
required

The patch of the deployment.

Show attributes
from
string

The path the operation is from.

old_value
unknown

The old value of the operation.

op
enum
required

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

path
string
required

The path of the operation.

value
unknown

The value of the operation.

source
object

Describes the source of a deployment.

Show attributes
git
object

Describes the git source of a deployment.

Show attributes
commit
object
required
Show attributes
author
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

committer
object
required
Show attributes
email
string

The email of the git commit author.

id
string

The ID of the git commit author.

login
string

The login of the git commit author.

name
string

The name of the git commit author.

message
string
required

The message of the git commit.

sha
string
required

The SHA of the git commit.

installation_id
string
required

The installation ID of the git provider.

owner
string
required

The owner of the git repository.

provider
enum
required

The git provider. One of github.

pull_request
string

The ID of the pull request.

ref
string
required

The tag or branch of the git repository.

repo
string
required

The name of the git repository.

repo_id
string
required

The ID of the git repository.

registry
object

Describes the registry source of a deployment.

Show attributes
command
array (string)

The command of the registry.

image
string
required

The image of the registry.

stacks
array (object)

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

Show attributes
id
string
required

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
enum
required

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
string

The reason for the stack's status.

timestamp
string (date-time)
required

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

environment_id
string
required

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
string (date-time)

The time the deployment finished.

id
string
required

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
array (string)
required

The IDS of stacks included in the deployment.

started_at
string (date-time)

The time the deployment started.

status
enum
required

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

updated_at
string (date-time)
required

The time the deployment was last updated.

has_more
boolean
required

Whether there are more results available.

next_page
string

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
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

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

message
string
required

The message of the error.

API Reference

Explore the API reference by resource type

Post to