Environments API

List environments in an organization

List all of the environments for an organization.

get

/ v1 / environments

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

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

cloud_version_id

string

required

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

config

object

required

The config of the environment.

Show attributes

object

created_at

string (date-time)

required

The time the environment was created.

description

string

A short description of the environment.

id

string

required

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

name

string

required

The name of the environment.

project_id

string

required

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

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.

Get an environment

Get an environment by its ID.

get

/ v1 / environments / :id

get

/ v1 / projects / :project_id / environments / :id

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

Path Parameters

id

string

required

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

cloud_version_id

string

required

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

config

object

required

The config of the environment.

Show attributes

object

created_at

string (date-time)

required

The time the environment was created.

description

string

A short description of the environment.

id

string

required

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

name

string

required

The name of the environment.

project_id

string

required

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

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.

Update an environment

Update an environment by its ID.

put

/ v1 / environments / :id

put

/ v1 / projects / :project_id / environments / :id

curl --request PUT \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

id

string

required

The ID of the environment to update. 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.

config

object

required

Show attributes

object

description

string

name

string (regexp)

required

The name of the environment. Must match the pattern ^[\p{L}\d_-]+$.

Responses

200

OK response.

cloud_version_id

string

required

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

config

object

required

The config of the environment.

Show attributes

object

created_at

string (date-time)

required

The time the environment was created.

description

string

A short description of the environment.

id

string

required

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

name

string

required

The name of the environment.

project_id

string

required

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

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.

Delete an environment

Delete an environment by its ID.

delete

/ v1 / environments / :id

delete

/ v1 / projects / :project_id / environments / :id

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

Path Parameters

id

string

required

The ID of the environment to delete. 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

No content

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 component logs

List logs for all components in an environment.

get

/ v1 / environments / :id / logs

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

Path Parameters

id

string

required

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

filter_pattern

string

The filter pattern to use when getting logs.

start_time

integer (int64)

The start time of the logs to get.

end_time

integer (int64)

The end time of the logs to get.

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.

Responses

200

OK response.

data

array (object)

required

An array of results.

Show attributes

component

object

Describes a component of a log entry from an environment container service.

Show attributes

deleted_at

string

The time the component was deleted.

id

string

required

The ID of the component.

name

string

required

The name of the component.

event_id

string

required

The ID of the event.

ingestion_time

integer (int64)

required

The ingestion time of the log entry.

message

string

required

The message of the log entry.

task_id

string

required

The ID of the task.

timestamp

integer (int64)

required

The timestamp of the log entry.

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 environment collaborators

List all of the members of an environment.

get

/ v1 / environments / :id / members

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

Path Parameters

id

string

required

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

role

array (string)

The role of the members to list.

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

account_id

string

required

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

avatar

string

The avatar of the member.

created_at

string (date-time)

required

The time the member was created.

display_name

string

required

The display name of the member.

environment_id

string

required

The environment ID. 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 membership. 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}$).

name

string

required

The name of the member.

org_role

enum

The role of a member within an org. One of owner, admin, member.

profile

object

required

Describes the profile of an org.

Show attributes

bio

string

The bio of the org.

github_handle

string

The GitHub handle of the org.

location

string

The location of the org.

twitter_handle

string

The Twitter handle of the org.

website

string

The website of the org.

role

enum

required

The role of a member within an environment. One of owner, contributor, viewer.

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.

Create an environment collaborator

Add members to an environment.

post

/ v1 / environments / :id / members

curl --request POST \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/members \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

id

string

required

The environment ID to add members 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}$).

Request Body

account_ids

array (string)

required

The member ID to look up. Must contain between 1 and 100 items.

Responses

201

Created response.

account_id

string

required

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

avatar

string

The avatar of the member.

created_at

string (date-time)

required

The time the member was created.

display_name

string

required

The display name of the member.

environment_id

string

required

The environment ID. 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 membership. 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}$).

name

string

required

The name of the member.

org_role

enum

The role of a member within an org. One of owner, admin, member.

profile

object

required

Describes the profile of an org.

Show attributes

bio

string

The bio of the org.

github_handle

string

The GitHub handle of the org.

location

string

The location of the org.

twitter_handle

string

The Twitter handle of the org.

website

string

The website of the org.

role

enum

required

The role of a member within an environment. One of owner, contributor, viewer.

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 environments in a project

List all of the environments for a project.

get

/ v1 / projects / :project_id / environments

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

Path Parameters

project_id

string

required

The project ID to scope the environments 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}$).

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

cloud_version_id

string

required

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

config

object

required

The config of the environment.

Show attributes

object

created_at

string (date-time)

required

The time the environment was created.

description

string

A short description of the environment.

id

string

required

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

name

string

required

The name of the environment.

project_id

string

required

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

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.

Create an environment

Create a new environment.

post

/ v1 / projects / :project_id / environments

curl --request POST \
     --url https://api.flexstack.com/v1/projects/1C8xJnvSBaztoHyxcim7C4/environments \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

project_id

string

required

The project ID to scope the environment 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}$).

Request Body

cloud_version_id

string

required

The cloud version ID to use for the environment. 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}$).

config

object

required

Show attributes

object

description

string

name

string (regexp)

required

The name of the environment. Must match the pattern ^[\p{L}\d_-]+$.

Responses

201

Created response.

cloud_version_id

string

required

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

config

object

required

The config of the environment.

Show attributes

object

created_at

string (date-time)

required

The time the environment was created.

description

string

A short description of the environment.

id

string

required

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

name

string

required

The name of the environment.

project_id

string

required

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

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.

Get an environment collaborator

Get a member of an environment by ID.

get

/ v1 / environments / :environment_id / members / :id

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

Path Parameters

environment_id

string

required

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

id

string

required

The member 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.

account_id

string

required

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

avatar

string

The avatar of the member.

created_at

string (date-time)

required

The time the member was created.

display_name

string

required

The display name of the member.

environment_id

string

required

The environment ID. 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 membership. 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}$).

name

string

required

The name of the member.

org_role

enum

The role of a member within an org. One of owner, admin, member.

profile

object

required

Describes the profile of an org.

Show attributes

bio

string

The bio of the org.

github_handle

string

The GitHub handle of the org.

location

string

The location of the org.

twitter_handle

string

The Twitter handle of the org.

website

string

The website of the org.

role

enum

required

The role of a member within an environment. One of owner, contributor, viewer.

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.

Update an environment collaborator

Update a member of an environment.

put

/ v1 / environments / :environment_id / members / :id

curl --request PUT \
     --url https://api.flexstack.com/v1/environments/1C8xJnvSBaztoHyxcim7C4/members/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

environment_id

string

required

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

id

string

required

The member 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.

role

enum

The role of the member within the environment. One of owner, contributor, viewer.

Responses

200

OK response.

account_id

string

required

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

avatar

string

The avatar of the member.

created_at

string (date-time)

required

The time the member was created.

display_name

string

required

The display name of the member.

environment_id

string

required

The environment ID. 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 membership. 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}$).

name

string

required

The name of the member.

org_role

enum

The role of a member within an org. One of owner, admin, member.

profile

object

required

Describes the profile of an org.

Show attributes

bio

string

The bio of the org.

github_handle

string

The GitHub handle of the org.

location

string

The location of the org.

twitter_handle

string

The Twitter handle of the org.

website

string

The website of the org.

role

enum

required

The role of a member within an environment. One of owner, contributor, viewer.

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.

Delete an environment collaborator

Delete a member of an environment.

delete

/ v1 / environments / :environment_id / members / :id

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

Path Parameters

environment_id

string

required

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

id

string

required

The member 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

No content

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.

Query Parameters

Responses

Path Parameters

Responses

Path Parameters

Request Body

Important note

Responses

Path Parameters

Responses

Path Parameters

Query Parameters

Responses

Path Parameters

Query Parameters

Responses

Path Parameters

Request Body

Responses

Path Parameters

Query Parameters

Responses

Path Parameters

Request Body

Responses

Path Parameters

Responses

Path Parameters

Request Body

Important note

Responses

Path Parameters

Responses

API Reference