Components API


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

Query Parameters

after
string
limit
integer (int64)
sort_by
enum

Responses

200
OK response.
data
array (object)
required
Show attributes
component_version
object
required
Show attributes
component_id
string
required
created_at
string (date-time)
required
id
string
required
name
string
required
slug
enum
required
version
string
required
config
object
required
Show attributes
object
container_service
object
Show attributes
created_at
string (date-time)
required
deployments
array (object)
required
Show attributes
created_at
string (date-time)
required
desired_count
integer (int32)
required
failed_tasks
integer (int32)
required
id
string
required
pending_count
integer (int32)
required
rollout_state
enum
required
running_count
integer (int32)
required
status
enum
required
desired_count
integer (int32)
required
pending_count
integer (int32)
required
running_count
integer (int32)
required
service_arn
string (regexp)
required
service_name
string
required
status
enum
required
created_at
string (date-time)
required
description
string
environment_id
string
required
id
string
required
name
string
required
stack_id
string
updated_at
string (date-time)
required
has_more
boolean
required
next_page
string
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
get
/ v1 / components / :id
get
/ v1 / environments / :environment_id / components / :id
curl --request GET \
     --url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

Responses

200
OK response.
component_version
object
required
Show attributes
component_id
string
required
created_at
string (date-time)
required
id
string
required
name
string
required
slug
enum
required
version
string
required
config
object
required
Show attributes
object
container_service
object
Show attributes
created_at
string (date-time)
required
deployments
array (object)
required
Show attributes
created_at
string (date-time)
required
desired_count
integer (int32)
required
failed_tasks
integer (int32)
required
id
string
required
pending_count
integer (int32)
required
rollout_state
enum
required
running_count
integer (int32)
required
status
enum
required
desired_count
integer (int32)
required
pending_count
integer (int32)
required
running_count
integer (int32)
required
service_arn
string (regexp)
required
service_name
string
required
status
enum
required
created_at
string (date-time)
required
description
string
environment_id
string
required
id
string
required
name
string
required
stack_id
string
updated_at
string (date-time)
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
put
/ v1 / components / :id
put
/ v1 / environments / :environment_id / components / :id
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

id
string
required

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.

config
object
required
Show attributes
object
description
string
name
string (regexp)
required

Responses

200
OK response.
component_version
object
required
Show attributes
component_id
string
required
created_at
string (date-time)
required
id
string
required
name
string
required
slug
enum
required
version
string
required
config
object
required
Show attributes
object
container_service
object
Show attributes
created_at
string (date-time)
required
deployments
array (object)
required
Show attributes
created_at
string (date-time)
required
desired_count
integer (int32)
required
failed_tasks
integer (int32)
required
id
string
required
pending_count
integer (int32)
required
rollout_state
enum
required
running_count
integer (int32)
required
status
enum
required
desired_count
integer (int32)
required
pending_count
integer (int32)
required
running_count
integer (int32)
required
service_arn
string (regexp)
required
service_name
string
required
status
enum
required
created_at
string (date-time)
required
description
string
environment_id
string
required
id
string
required
name
string
required
stack_id
string
updated_at
string (date-time)
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
delete
/ v1 / components / :id
delete
/ v1 / environments / :environment_id / components / :id
curl --request DELETE \
     --url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

Responses

204
No content
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
get
/ v1 / components / :id / logs
curl --request GET \
     --url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/logs \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

Query Parameters

filter_pattern
string
start_time
integer (int64)
end_time
integer (int64)
task_ids
array (string)
after
string
limit
integer (int64)

Responses

200
OK response.
data
array (object)
required
Show attributes
event_id
string
required
ingestion_time
integer (int64)
required
message
string
required
task_id
string
required
timestamp
integer (int64)
required
has_more
boolean
required
next_page
string
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
get
/ v1 / components / :id / metrics
curl --request GET \
     --url https://api.flexstack.com/v1/components/1C8xJnvSBaztoHyxcim7C4/metrics \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

Query Parameters

timeframe
enum

Responses

200
OK response.
cpu
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
invocation_complete_latency
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
invocation_count
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
invocation_failed_count
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
invocation_start_latency
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
memory
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
request_count
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
request_latency
object
Show attributes
avg
object
Show attributes
data
array (number)
required
unit
enum
required
count
object
Show attributes
data
array (number)
required
unit
enum
required
max
object
Show attributes
data
array (number)
required
unit
enum
required
min
object
Show attributes
data
array (number)
required
unit
enum
required
p99
object
Show attributes
data
array (number)
required
unit
enum
required
timestamps
array (integer)
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
get
/ v1 / environments / :id / components
curl --request GET \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/components \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

Query Parameters

after
string
limit
integer (int64)
sort_by
enum

Responses

200
OK response.
data
array (object)
required
Show attributes
component_version
object
required
Show attributes
component_id
string
required
created_at
string (date-time)
required
id
string
required
name
string
required
slug
enum
required
version
string
required
config
object
required
Show attributes
object
container_service
object
Show attributes
created_at
string (date-time)
required
deployments
array (object)
required
Show attributes
created_at
string (date-time)
required
desired_count
integer (int32)
required
failed_tasks
integer (int32)
required
id
string
required
pending_count
integer (int32)
required
rollout_state
enum
required
running_count
integer (int32)
required
status
enum
required
desired_count
integer (int32)
required
pending_count
integer (int32)
required
running_count
integer (int32)
required
service_arn
string (regexp)
required
service_name
string
required
status
enum
required
created_at
string (date-time)
required
description
string
environment_id
string
required
id
string
required
name
string
required
stack_id
string
updated_at
string (date-time)
required
has_more
boolean
required
next_page
string
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
post
/ v1 / environments / :id / components
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

id
string
required

Request Body

component_version_id
string
required
config
object
required
Show attributes
object
description
string
name
string (regexp)
required
variables
object
Show attributes
object

Responses

201
Created response.
component_version
object
required
Show attributes
component_id
string
required
created_at
string (date-time)
required
id
string
required
name
string
required
slug
enum
required
version
string
required
config
object
required
Show attributes
object
container_service
object
Show attributes
created_at
string (date-time)
required
deployments
array (object)
required
Show attributes
created_at
string (date-time)
required
desired_count
integer (int32)
required
failed_tasks
integer (int32)
required
id
string
required
pending_count
integer (int32)
required
rollout_state
enum
required
running_count
integer (int32)
required
status
enum
required
desired_count
integer (int32)
required
pending_count
integer (int32)
required
running_count
integer (int32)
required
service_arn
string (regexp)
required
service_name
string
required
status
enum
required
created_at
string (date-time)
required
description
string
environment_id
string
required
id
string
required
name
string
required
stack_id
string
updated_at
string (date-time)
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
put
/ v1 / components / :component_id / 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

component_id
string
required

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.

domain_name
string
required
idempotency_token
string
required

Responses

201
Created response.
certificate_status
enum
required
domain_name
string
required
domain_status
enum
required
id
string (regexp)
required
route53_change_id
string
validation_records
array (object)
required
Show attributes
name
string
required
type
string
required
value
string
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
get
/ v1 / components / :component_id / domain-validation / :domain_name
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

component_id
string
required
domain_name
string
required

Query Parameters

route53_change_id
string

Responses

200
OK response.
certificate_status
enum
required
domain_name
string
required
domain_status
enum
required
id
string (regexp)
required
route53_change_id
string
validation_records
array (object)
required
Show attributes
name
string
required
type
string
required
value
string
required
400
Bad Request response.
cause
unknown
code
enum
required
message
string
required
401
Unauthorized response.
cause
unknown
code
enum
required
message
string
required
403
Forbidden response.
cause
unknown
code
enum
required
message
string
required
404
Not Found response.
cause
unknown
code
enum
required
message
string
required
408
Request Timeout response.
cause
unknown
code
enum
required
message
string
required
409
Conflict response.
cause
unknown
code
enum
required
message
string
required
429
Too Many Requests response.
cause
unknown
code
enum
required
message
string
required
500
Internal Server Error response.
cause
unknown
code
enum
required
message
string
required
501
Not Implemented response.
cause
unknown
code
enum
required
message
string
required
Post to