Stacks API

Stacks are deployable units of infrastructure that are managed by FlexStack on your behalf.

List stacks in an org

List all stacks in an org.

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

Query Parameters

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 stack was created at FlexStack.

environment_id
string
required

The ID of the environment the stack 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}$).

id
string
required

The ID of the stack.

latest_deployment_id
string

The ID of the latest deployment of the stack that is not in a pending state. 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}$).

outputs
object
required

The outputs of the stack.

Show attributes
object
resource_id
string

The cloud ID of the stack.

stack_type
enum
required

The type of the stack. One of vpc, component, component_group.

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)

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

updated_at
string (date-time)
required

The time the stack was last updated at FlexStack.

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 stack

Get a stack by its ID.

get
/ v1 / stacks / :id
get
/ v1 / environments / :environment_id / stacks / :id 
curl --request GET \
     --url https://api.flexstack.com/v1/stacks/Beatae%20et%20consequatur%20vel%20explicabo. \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The ID of the stack to get.

Responses

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

The time the stack was created at FlexStack.

environment_id
string
required

The ID of the environment the stack 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}$).

id
string
required

The ID of the stack.

latest_deployment_id
string

The ID of the latest deployment of the stack that is not in a pending state. 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}$).

outputs
object
required

The outputs of the stack.

Show attributes
object
resource_id
string

The cloud ID of the stack.

stack_type
enum
required

The type of the stack. One of vpc, component, component_group.

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)

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

updated_at
string (date-time)
required

The time the stack was last updated at FlexStack.

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 component's stack

Get the stack that a component is in.

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

Path Parameters

component_id
string
required

The ID of the component to get a stack from. 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}$).

Responses

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

The time the stack was created at FlexStack.

environment_id
string
required

The ID of the environment the stack 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}$).

id
string
required

The ID of the stack.

latest_deployment_id
string

The ID of the latest deployment of the stack that is not in a pending state. 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}$).

outputs
object
required

The outputs of the stack.

Show attributes
object
resource_id
string

The cloud ID of the stack.

stack_type
enum
required

The type of the stack. One of vpc, component, component_group.

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)

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

updated_at
string (date-time)
required

The time the stack was last updated at FlexStack.

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 stacks in an environment

List all stacks in an environment.

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

Path Parameters

environment_id
string
required

The ID of the environment to get stacks from. 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

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 stack was created at FlexStack.

environment_id
string
required

The ID of the environment the stack 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}$).

id
string
required

The ID of the stack.

latest_deployment_id
string

The ID of the latest deployment of the stack that is not in a pending state. 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}$).

outputs
object
required

The outputs of the stack.

Show attributes
object
resource_id
string

The cloud ID of the stack.

stack_type
enum
required

The type of the stack. One of vpc, component, component_group.

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)

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

updated_at
string (date-time)
required

The time the stack was last updated at FlexStack.

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 component's container service

Get the service that a component runs on.

get
/ v1 / components / :component_id / container-service 
curl --request GET \
     --url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/container-service \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

component_id
string
required

The ID of the component to get a stack from. 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}$).

Responses

200
OK response.
cluster_arn
string (regexp)
required

The ARN of the ECS cluster. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

created_at
string (date-time)
required

The time the ECS service was created.

deployments
array (object)
required

The deployments of the ECS service.

Show attributes
created_at
string (date-time)
required

The time the ECS service deployment was created.

desired_count
integer (int32)
required

The desired count of the ECS service deployment.

failed_tasks
integer (int32)
required

The failed tasks of the ECS service deployment.

id
string
required

The ID of the ECS service deployment.

pending_count
integer (int32)
required

The pending count of the ECS service deployment.

rollout_state
enum
required

The rollout state of the ECS service deployment. One of COMPLETED, FAILED, IN_PROGRESS.

rollout_state_reason
string

The rollout state reason of the ECS service deployment.

running_count
integer (int32)
required

The running count of the ECS service deployment.

service_connect_configuration
object
required
Show attributes
namespace
string (regexp)
required

The namespace of the service connect configuration. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

services
array (object)
required

The services of the service connect configuration.

Show attributes
client_aliases
array (object)
required

The client aliases of the service connect service.

Show attributes
dns_name
string (hostname)
required

The DNS name of the service connect client alias.

port
integer (int32)
required

The port of the service connect client alias. Must be between 1 and 65535.

discovery_name
string
required

The discovery name of the service connect service.

port_name
string
required

The port name of the service connect service.

status
enum
required

The status of the ECS service deployment. One of ACTIVE, PRIMARY, DRAINING, INACTIVE.

desired_count
integer (int32)
required

The desired count of the ECS service.

events
array (object)
required

The events of the ECS service.

Show attributes
created_at
string (date-time)
required

The time the ECS service event was created.

id
string
required

The ID of the ECS service event.

message
string
required

The message of the ECS service event.

id
string
required

The ID of the ECS service. 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}$).

pending_count
integer (int32)
required

The pending count of the ECS service.

running_count
integer (int32)
required

The running count of the ECS service.

service_arn
string (regexp)
required

The ARN of the ECS service. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

service_name
string
required

The name of the ECS service.

stack_component_id
string
required

The ID of the stack component the ECS service 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}$).

status
enum
required

The status of the ECS service. One of ACTIVE, DRAINING, INACTIVE.

task_definition
string (regexp)
required

The task definition of the ECS service. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

tasks
array (object)
required

The tasks of the ECS service.

Show attributes
availability_zone
string
required

The availability zone of the ECS service task.

connectivity
enum
required

The connectivity of the ECS service task. One of CONNECTED, DISCONNECTED.

connectivity_at
string (date-time)

The time the ECS service task's connectivity was last updated.

containers
array (object)
required

The containers of the ECS service task.

Show attributes
container_arn
string (regexp)
required

The ARN of the ECS service task container. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

cpu
string

The CPU of the ECS service task container.

exit_code
integer (int32)

The exit code of the ECS service task container.

health_status
enum
required

The health status of the ECS service task container. One of HEALTHY, UNHEALTHY, UNKNOWN.

image
string

The image of the ECS service task container.

image_digest
string

The image digest of the ECS service task container.

last_status
enum
required

The last status of the ECS service task container. One of PROVISIONING, PENDING, ACTIVATING, RUNNING, DEACTIVATING, STOPPING, DEPROVISIONING, STOPPED.

memory
string

The memory of the ECS service task container.

name
string
required

The name of the ECS service task container.

reason
string

The reason of the ECS service task container.

runtime_id
string

The runtime ID of the ECS service task container.

cpu
string
required

The CPU of the ECS service task.

created_at
string (date-time)
required

The time the ECS service task was created.

desired_status
enum
required

The desired status of the ECS service task. One of PROVISIONING, PENDING, ACTIVATING, RUNNING, DEACTIVATING, STOPPING, DEPROVISIONING, STOPPED.

ephemeral_storage_gib
integer (int32)
required

The ephemeral storage GiB of the ECS service task.

execution_stopped_at
string (date-time)

The time the ECS service task's execution was stopped.

group
string
required

The group of the ECS service task.

health_status
enum
required

The health status of the ECS service task. One of HEALTHY, UNHEALTHY, UNKNOWN.

ipv6_address
string (ipv6)
required

The IPv6 address of the ECS service task.

last_status
enum
required

The last status of the ECS service task. One of PROVISIONING, PENDING, ACTIVATING, RUNNING, DEACTIVATING, STOPPING, DEPROVISIONING, STOPPED.

launch_type
enum
required

The launch type of the ECS service task. One of EC2, FARGATE, EXTERNAL.

memory
string
required

The memory of the ECS service task.

private_dns_name
string (hostname)
required

The private DNS name of the ECS service task.

private_ipv4_address
string (ipv4)
required

The private IPv4 address of the ECS service task.

pull_started_at
string (date-time)

The time the ECS service task's pull was started.

pull_stopped_at
string (date-time)

The time the ECS service task's pull was stopped.

started_at
string (date-time)

The time the ECS service task was started.

stop_code
enum

The stop code of the ECS service task. One of TaskFailedToStart, EssentialContainerExited, UserInitiated, ServiceSchedulerInitiated, SpotInterruption, TerminationNotice.

stopped_at
string (date-time)

The time the ECS service task was stopped.

stopped_reason
string

The stopped reason of the ECS service task.

stopping_at
string (date-time)

The time the ECS service task was stopping.

task_arn
string (regexp)
required

The ARN of the ECS service task. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

task_definition_arn
string (regexp)
required

The ARN of the ECS service task definition. Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.

updated_at
string (date-time)
required

The time the ECS service 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.

API Reference

Explore the API reference by resource type

Post to