Resources API

View the cloud resources that are managed by FlexStack on your behalf.

Get a resource

Get a resource by its ID.

Path Parameters

id

The ID of the resource to get. 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 resource was created at FlexStack.

environment_id

The ID of the environment the resource 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

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

physical_id

The unique ID of the resource within its region at the cloud provider.

resource_type

The type of the resource.

stack_id

The ID of the stack the resource 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 resource. One of CREATE_COMPLETE, CREATE_FAILED, CREATE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS, DELETE_SKIPPED, IMPORT_COMPLETE, IMPORT_FAILED, IMPORT_IN_PROGRESS, IMPORT_ROLLBACK_COMPLETE, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED, ROLLBACK_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_IN_PROGRESS.

status_reason

The reason for the resource's status.

template_id

The ID of the resource in its stack's template.

timestamp

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

updated_at

The time the resource 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 resources in a stack

List all resources in a stack.

Path Parameters

stack_id

The ID of the stack to get resources from.

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

environment_id

The ID of the environment the resource 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

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

physical_id

The unique ID of the resource within its region at the cloud provider.

resource_type

The type of the resource.

stack_id

The ID of the stack the resource 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 resource. One of CREATE_COMPLETE, CREATE_FAILED, CREATE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS, DELETE_SKIPPED, IMPORT_COMPLETE, IMPORT_FAILED, IMPORT_IN_PROGRESS, IMPORT_ROLLBACK_COMPLETE, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED, ROLLBACK_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_IN_PROGRESS.

status_reason

The reason for the resource's status.

template_id

The ID of the resource in its stack's template.

timestamp

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

updated_at

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

List resources in an environment

List all resources in an environment.

Path Parameters

environment_id

The ID of the environment to get resources 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 resource was created at FlexStack.

environment_id

The ID of the environment the resource 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

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

physical_id

The unique ID of the resource within its region at the cloud provider.

resource_type

The type of the resource.

stack_id

The ID of the stack the resource 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 resource. One of CREATE_COMPLETE, CREATE_FAILED, CREATE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS, DELETE_SKIPPED, IMPORT_COMPLETE, IMPORT_FAILED, IMPORT_IN_PROGRESS, IMPORT_ROLLBACK_COMPLETE, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED, ROLLBACK_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_IN_PROGRESS.

status_reason

The reason for the resource's status.

template_id

The ID of the resource in its stack's template.

timestamp

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

updated_at

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

API Reference

Explore the API reference by resource type

Post to