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.

Query Parameters

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

environment_id

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}$).

The ID of the stack.

latest_deployment_id

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

The outputs of the stack.

Show attributes

resource_id

The cloud ID of the stack.

stack_type

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

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.

updated_at

The time the stack was last updated at FlexStack.

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 stack

Get a stack by its ID.

Path Parameters

The ID of the stack to get.

Responses

200

OK response.

created_at

The time the stack was created at FlexStack.

environment_id

The ID of the stack.

latest_deployment_id

outputs

The outputs of the stack.

Show attributes

resource_id

The cloud ID of the stack.

stack_type

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

status

status_reason

The reason for the stack's status.

timestamp

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

updated_at

The time the stack was last updated at FlexStack.

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

Get the stack that a component is in.

Path Parameters

component_id

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

The time the stack was created at FlexStack.

environment_id

The ID of the stack.

latest_deployment_id

outputs

The outputs of the stack.

Show attributes

resource_id

The cloud ID of the stack.

stack_type

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

status

status_reason

The reason for the stack's status.

timestamp

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

updated_at

The time the stack was last updated at FlexStack.

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

List all stacks in an environment.

Path Parameters

environment_id

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

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

environment_id

The ID of the stack.

latest_deployment_id

outputs

The outputs of the stack.

Show attributes

resource_id

The cloud ID of the stack.

stack_type

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

status

status_reason

The reason for the stack's status.

timestamp

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

updated_at

The time the stack was last updated at FlexStack.

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

Get the service that a component runs on.

Path Parameters

component_id

Responses

200

OK response.

cluster_arn

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

created_at

The time the ECS service was created.

deployments

The deployments of the ECS service.

Show attributes

created_at

The time the ECS service deployment was created.

desired_count

The desired count of the ECS service deployment.

failed_tasks

The failed tasks of the ECS service deployment.

The ID of the ECS service deployment.

pending_count

The pending count of the ECS service deployment.

rollout_state

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

rollout_state_reason

The rollout state reason of the ECS service deployment.

running_count

The running count of the ECS service deployment.

service_connect_configuration

Show attributes

namespace

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

services

The services of the service connect configuration.

Show attributes

client_aliases

The client aliases of the service connect service.

Show attributes

dns_name

The DNS name of the service connect client alias.

port

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

discovery_name

The discovery name of the service connect service.

port_name

The port name of the service connect service.

status

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

desired_count

The desired count of the ECS service.

events

The events of the ECS service.

Show attributes

created_at

The time the ECS service event was created.

The ID of the ECS service event.

message

The message of the ECS service event.

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

The pending count of the ECS service.

running_count

The running count of the ECS service.

service_arn

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

service_name

The name of the ECS service.

stack_component_id

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

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

task_definition

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

tasks

The tasks of the ECS service.

Show attributes

availability_zone

The availability zone of the ECS service task.

connectivity

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

connectivity_at

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

containers

The containers of the ECS service task.

Show attributes

container_arn

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

cpu

The CPU of the ECS service task container.

exit_code

The exit code of the ECS service task container.

health_status

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

image

The image of the ECS service task container.

image_digest

The image digest of the ECS service task container.

last_status

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

memory

The memory of the ECS service task container.

name

The name of the ECS service task container.

reason

The reason of the ECS service task container.

runtime_id

The runtime ID of the ECS service task container.

cpu

The CPU of the ECS service task.

created_at

The time the ECS service task was created.

desired_status

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

ephemeral_storage_gib

The ephemeral storage GiB of the ECS service task.

execution_stopped_at

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

group

The group of the ECS service task.

health_status

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

ipv6_address

The IPv6 address of the ECS service task.

last_status

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

launch_type

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

memory

The memory of the ECS service task.

private_dns_name

The private DNS name of the ECS service task.

private_ipv4_address

The private IPv4 address of the ECS service task.

pull_started_at

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

pull_stopped_at

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

started_at

The time the ECS service task was started.

stop_code

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

stopped_at

The time the ECS service task was stopped.

stopped_reason

The stopped reason of the ECS service task.

stopping_at

The time the ECS service task was stopping.

task_arn

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

task_definition_arn

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

updated_at

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

API Reference

Explore the API reference by resource type