List components in an org
List all of the components for an org.
curl --request GET \
--url https://api.flexstack.com/v1/components \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Query Parameters
A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.
The maximum number of results to return. Must be between 1 and 240.
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.
An array of results.
Show attributes
Describes a component version.
Show attributes
The ID of the component the version 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 time the org was created.
The ID of the component version. 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 name of the version.
The slug of the version. One of web-service, private-service, scheduled-job, worker.
The version number.
The config of the component.
Show attributes
Describes the ECS service a component is running on.
Show attributes
The time the ECS service was created.
The deployments of the ECS service.
Show attributes
The time the ECS service deployment was created.
The desired count of the ECS service deployment.
The failed tasks of the ECS service deployment.
The ID of the ECS service deployment.
The pending count of the ECS service deployment.
One of COMPLETED, FAILED, IN_PROGRESS.
The running count of the ECS service deployment.
One of ACTIVE, PRIMARY, DRAINING, INACTIVE.
The desired count of the ECS service.
The pending count of the ECS service.
The running count of the ECS service.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The name of the ECS service.
One of ACTIVE, DRAINING, INACTIVE.
The time the component was created.
A short description of the component.
The environment the component 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 component. 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 name of the component.
The stack the component belongs to.
The last time the component was updated.
Whether there are more results available.
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.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Get a component
Get a component in an org.
curl --request GET \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4 \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The component ID to look up. 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.
Describes a component version.
Show attributes
The ID of the component the version 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 time the org was created.
The ID of the component version. 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 name of the version.
The slug of the version. One of web-service, private-service, scheduled-job, worker.
The version number.
The config of the component.
Show attributes
Describes the ECS service a component is running on.
Show attributes
The time the ECS service was created.
The deployments of the ECS service.
Show attributes
The time the ECS service deployment was created.
The desired count of the ECS service deployment.
The failed tasks of the ECS service deployment.
The ID of the ECS service deployment.
The pending count of the ECS service deployment.
One of COMPLETED, FAILED, IN_PROGRESS.
The running count of the ECS service deployment.
One of ACTIVE, PRIMARY, DRAINING, INACTIVE.
The desired count of the ECS service.
The pending count of the ECS service.
The running count of the ECS service.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The name of the ECS service.
One of ACTIVE, DRAINING, INACTIVE.
The time the component was created.
A short description of the component.
The environment the component 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 component. 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 name of the component.
The stack the component belongs to.
The last time the component was updated.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Update a component
Update a component in an org.
curl --request PUT \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4 \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
--header 'content-type: application/json'Path Parameters
The component ID to look up. 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}$).
Request Body
Important note
PUT requests are used to replace an existing resource.
The request body should contain the full representation of the
resource, including any fields that are not being updated.
Show attributes
The name of the environment. Must match the pattern ^[\p{L}\d_-]+$.
Responses
200 OK response.
Describes a component version.
Show attributes
The ID of the component the version 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 time the org was created.
The ID of the component version. 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 name of the version.
The slug of the version. One of web-service, private-service, scheduled-job, worker.
The version number.
The config of the component.
Show attributes
Describes the ECS service a component is running on.
Show attributes
The time the ECS service was created.
The deployments of the ECS service.
Show attributes
The time the ECS service deployment was created.
The desired count of the ECS service deployment.
The failed tasks of the ECS service deployment.
The ID of the ECS service deployment.
The pending count of the ECS service deployment.
One of COMPLETED, FAILED, IN_PROGRESS.
The running count of the ECS service deployment.
One of ACTIVE, PRIMARY, DRAINING, INACTIVE.
The desired count of the ECS service.
The pending count of the ECS service.
The running count of the ECS service.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The name of the ECS service.
One of ACTIVE, DRAINING, INACTIVE.
The time the component was created.
A short description of the component.
The environment the component 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 component. 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 name of the component.
The stack the component belongs to.
The last time the component was updated.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Delete a component
Delete a component in an org.
curl --request DELETE \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4 \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The component ID to look up. 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
204
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
List component logs
List the logs for a component.
curl --request GET \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/logs \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The ID of the component to get logs for. 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
The filter pattern to use when getting logs.
The start time of the logs to get.
The end time of the logs to get.
The tasks to get logs for.
A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.
The maximum number of results to return. Must be between 1 and 240.
Responses
200 OK response.
An array of results.
Show attributes
The ID of the event.
The ingestion time of the log entry.
The message of the log entry.
The ID of the task.
The timestamp of the log entry.
Whether there are more results available.
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.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Get component metrics
Get the metrics for a component.
curl --request GET \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/metrics \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The ID of the component to get metrics for. 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
Describes the timeframe of a metric. One of 15m, 1h, 3h, 6h, 12h, 1d, 7d, 30d, 90d.
Responses
200 OK response.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
Describes the data of a metric.
Show attributes
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
Describes the data of a metric.
Show attributes
The value of the metric.
Describes the unit of a metric. One of percent, count, milliseconds.
The timestamps of the metrics.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
List components in an environment
List all of the components for an environment.
curl --request GET \
--url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/components \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The environment ID to look up. 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
A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.
The maximum number of results to return. Must be between 1 and 240.
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.
An array of results.
Show attributes
Describes a component version.
Show attributes
The ID of the component the version 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 time the org was created.
The ID of the component version. 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 name of the version.
The slug of the version. One of web-service, private-service, scheduled-job, worker.
The version number.
The config of the component.
Show attributes
Describes the ECS service a component is running on.
Show attributes
The time the ECS service was created.
The deployments of the ECS service.
Show attributes
The time the ECS service deployment was created.
The desired count of the ECS service deployment.
The failed tasks of the ECS service deployment.
The ID of the ECS service deployment.
The pending count of the ECS service deployment.
One of COMPLETED, FAILED, IN_PROGRESS.
The running count of the ECS service deployment.
One of ACTIVE, PRIMARY, DRAINING, INACTIVE.
The desired count of the ECS service.
The pending count of the ECS service.
The running count of the ECS service.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The name of the ECS service.
One of ACTIVE, DRAINING, INACTIVE.
The time the component was created.
A short description of the component.
The environment the component 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 component. 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 name of the component.
The stack the component belongs to.
The last time the component was updated.
Whether there are more results available.
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.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Create a component
Create a new component in an environment.
curl --request POST \
--url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/components \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
--header 'content-type: application/json'Path Parameters
The environment ID to create a component in. 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}$).
Request Body
The component version ID.
The config of the component.
Show attributes
A short description of the component.
The name of the component. Must match the pattern ^[\p{L}\d_-]+$.
Environment variables to create for the component.
Show attributes
Responses
201 Created response.
Describes a component version.
Show attributes
The ID of the component the version 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 time the org was created.
The ID of the component version. 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 name of the version.
The slug of the version. One of web-service, private-service, scheduled-job, worker.
The version number.
The config of the component.
Show attributes
Describes the ECS service a component is running on.
Show attributes
The time the ECS service was created.
The deployments of the ECS service.
Show attributes
The time the ECS service deployment was created.
The desired count of the ECS service deployment.
The failed tasks of the ECS service deployment.
The ID of the ECS service deployment.
The pending count of the ECS service deployment.
One of COMPLETED, FAILED, IN_PROGRESS.
The running count of the ECS service deployment.
One of ACTIVE, PRIMARY, DRAINING, INACTIVE.
The desired count of the ECS service.
The pending count of the ECS service.
The running count of the ECS service.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The name of the ECS service.
One of ACTIVE, DRAINING, INACTIVE.
The time the component was created.
A short description of the component.
The environment the component 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 component. 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 name of the component.
The stack the component belongs to.
The last time the component was updated.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Create a domain validation for a component
Create a domain validation.
curl --request PUT \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/domain-validation \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
--header 'content-type: application/json'Path Parameters
The ID of the component to look up the validation status for. 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}$).
Request Body
Important note
PUT requests are used to replace an existing resource.
The request body should contain the full representation of the
resource, including any fields that are not being updated.
The domain name to validate.
The idempotency token.
Responses
201 Created response.
Describes the status of a certificate. One of PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, REVOKED, FAILED.
The domain name to validate.
Describes the status of a domain validation. One of PENDING_VALIDATION, SUCCESS, FAILED.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The ID of the Route53 change.
The validation records of the domain validation.
Show attributes
The name of the validation record.
The type of the validation record.
The value of the validation record.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
Get component domain validation
Get the status of a domain validation.
curl --request GET \
--url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/domain-validation/Tempore%20ad%20quibusdam%20quia%20quam%20omnis. \
--header 'accept: application/json' \
--header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'Path Parameters
The ID of the component to look up the validation status for. 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 domain name to look up the validation status for.
Query Parameters
The ID of the Route53 change.
Responses
200 OK response.
Describes the status of a certificate. One of PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, REVOKED, FAILED.
The domain name to validate.
Describes the status of a domain validation. One of PENDING_VALIDATION, SUCCESS, FAILED.
Must match the pattern ^arn:[\w]+:[\w-]+:[\w-]+:[\d]{12}:[\w-]+/[\w-:]+$.
The ID of the Route53 change.
The validation records of the domain validation.
Show attributes
The name of the validation record.
The type of the validation record.
The value of the validation record.
400 Bad Request response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
401 Unauthorized response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
403 Forbidden response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
404 Not Found response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
408 Request Timeout response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
409 Conflict response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
429 Too Many Requests response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
500 Internal Server Error response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
501 Not Implemented response.
The cause of the error.
The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.
The message of the error.
API Reference
Explore the API reference by resource type