Resources API

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

Get a resource

Get a resource by its ID.

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

Path Parameters

id
string
required

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

The time the resource was created at FlexStack.

environment_id
string
required

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

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

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

resource_type
string
required

The type of the resource.

stack_id
string
required

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

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
string

The reason for the resource's status.

template_id
string
required

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

timestamp
string (date-time)
required

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

updated_at
string (date-time)
required

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

List all resources in a stack.

get
/ v1 / stacks / :stack_id / resources 
curl --request GET \
     --url https://api.flexstack.com/v1/stacks/Provident%20est%20perspiciatis%20recusandae%20voluptatum%20sed%20dolores./resources \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

stack_id
string
required

The ID of the stack to get resources from.

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

environment_id
string
required

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

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

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

resource_type
string
required

The type of the resource.

stack_id
string
required

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

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
string

The reason for the resource's status.

template_id
string
required

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

timestamp
string (date-time)
required

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

updated_at
string (date-time)
required

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

List resources in an environment

List all resources in an environment.

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

Path Parameters

environment_id
string
required

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

environment_id
string
required

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

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

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

resource_type
string
required

The type of the resource.

stack_id
string
required

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

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
string

The reason for the resource's status.

template_id
string
required

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

timestamp
string (date-time)
required

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

updated_at
string (date-time)
required

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

API Reference

Explore the API reference by resource type

Post to