Projects API

Manage your organization's projects.

List projects

List all of the projects for an organization.

get
/ v1 / projects 
curl --request GET \
     --url https://api.flexstack.com/v1/projects \
     --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
connection_status
enum
required

Whether or not the project has established a connection to a cloud provider. One of connected, disconnected, disconnecting.

created_at
string (date-time)
required

The time the org was created.

default_environment_id
string
required

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

description
string

A short description of the project.

icon
string

An icon for the project.

id
string
required

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

org_id
string
required

The ID of the organization the project 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 a project

Create a new project.

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

Request Body

description
string
icon
string (regexp)

Must match the pattern ^(icon|emoji|url):(.+)$.

name
string
required

Responses

201
Created response.
connection_status
enum
required

Whether or not the project has established a connection to a cloud provider. One of connected, disconnected, disconnecting.

created_at
string (date-time)
required

The time the org was created.

default_environment_id
string
required

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

description
string

A short description of the project.

icon
string

An icon for the project.

id
string
required

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

org_id
string
required

The ID of the organization the project 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 a project

Get a project by its ID.

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

Path Parameters

id
string
required

The ID of the project 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.
connection_status
enum
required

Whether or not the project has established a connection to a cloud provider. One of connected, disconnected, disconnecting.

created_at
string (date-time)
required

The time the org was created.

default_environment_id
string
required

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

description
string

A short description of the project.

icon
string

An icon for the project.

id
string
required

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

org_id
string
required

The ID of the organization the project 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 a project

Update a project by its ID.

put
/ v1 / projects / :id 
curl --request PUT \
     --url https://api.flexstack.com/v1/projects/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 project. 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.

default_environment_id
string
required

Set the default project 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}$).

description
string
icon
string (regexp)

Must match the pattern ^(icon|emoji|url):(.+)$.

name
string
required

Responses

200
OK response.
connection_status
enum
required

Whether or not the project has established a connection to a cloud provider. One of connected, disconnected, disconnecting.

created_at
string (date-time)
required

The time the org was created.

default_environment_id
string
required

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

description
string

A short description of the project.

icon
string

An icon for the project.

id
string
required

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

org_id
string
required

The ID of the organization the project 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 a project

Delete a project by its ID.

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

Path Parameters

id
string
required

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

List all of the members of an project.

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

Path Parameters

id
string
required

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

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 the member within the 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.

project_id
string
required

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

role
enum
required

The role of the member within the project. 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 project collaborator

Add members to an project.

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

Path Parameters

id
string
required

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

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 the member within the 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.

project_id
string
required

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

role
enum
required

The role of the member within the project. 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 projects by organization

List all of the projects for an organization.

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

Path Parameters

org_id
string
required

The organization ID to scope the project 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
connection_status
enum
required

Whether or not the project has established a connection to a cloud provider. One of connected, disconnected, disconnecting.

created_at
string (date-time)
required

The time the org was created.

default_environment_id
string
required

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

description
string

A short description of the project.

icon
string

An icon for the project.

id
string
required

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

org_id
string
required

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

Disconnect a project

Disconnect a project from the cloud provider.

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

Path Parameters

id
string
required

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

Get an project collaborator

Get a member of an project by ID.

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

Path Parameters

project_id
string
required

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

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 the member within the 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.

project_id
string
required

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

role
enum
required

The role of the member within the project. 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 project collaborator

Update a member of an project.

put
/ v1 / projects / :project_id / members / :id 
curl --request PUT \
     --url https://api.flexstack.com/v1/projects/1C8xJnvSBaztoHyxcim7C4/members/1C8xJnvSBaztoHyxcim7C4 \
     --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 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 project. 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.

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 the member within the 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.

project_id
string
required

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

role
enum
required

The role of the member within the project. 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 project collaborator

Delete a member of an project.

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

Path Parameters

project_id
string
required

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

List notifications integrations

List the notifications integrations for a project.

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

Path Parameters

project_id
string
required

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

Responses

200
OK response.
config
unknown
required

The configuration of the integration.

created_at
string (date-time)
required

The time the integration was created.

id
string
required

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

preferences
object
required
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

project_id
string
required

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

type
enum
required

The type of integration. One of slack, webhook.

updated_at
string (date-time)
required

The time the integration was updated.

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 a notifications integration

Create a notifications integration for a project.

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

Path Parameters

project_id
string
required

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

Request Body

config
object
required

The configuration of the integration.

Show attributes
object
preferences
object
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

type
enum
required

The type of integration. One of webhook.

Responses

201
Created response.
config
unknown
required

The configuration of the integration.

created_at
string (date-time)
required

The time the integration was created.

id
string
required

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

preferences
object
required
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

project_id
string
required

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

type
enum
required

The type of integration. One of slack, webhook.

updated_at
string (date-time)
required

The time the integration was updated.

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 a notifications integration

Get the notifications integration for a project.

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

Path Parameters

project_id
string
required

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

Responses

200
OK response.
config
unknown
required

The configuration of the integration.

created_at
string (date-time)
required

The time the integration was created.

id
string
required

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

preferences
object
required
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

project_id
string
required

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

type
enum
required

The type of integration. One of slack, webhook.

updated_at
string (date-time)
required

The time the integration was updated.

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 a notifications integration

Update a notifications integration for a project.

patch
/ v1 / projects / :project_id / notification-integrations / :id 
curl --request PATCH \
     --url https://api.flexstack.com/v1/projects/1C8xJnvSBaztoHyxcim7C4/notification-integrations/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

project_id
string
required

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

Request Body

preferences
object
required
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

Responses

200
OK response.
config
unknown
required

The configuration of the integration.

created_at
string (date-time)
required

The time the integration was created.

id
string
required

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

preferences
object
required
Show attributes
deployments.failed
boolean
required

Deployments failed notification is enabled.

deployments.in_progress
boolean
required

Deployments in progress notification is enabled.

deployments.succeeded
boolean
required

Deployments succeeded notification is enabled.

marketing.changelog
boolean
required

Changelog notification is enabled.

marketing.promotions
boolean
required

Promotions notification is enabled.

services.in_alarm
boolean
required

Services in alarm notification is enabled.

services.ok
boolean
required

Services OK notification is enabled.

project_id
string
required

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

type
enum
required

The type of integration. One of slack, webhook.

updated_at
string (date-time)
required

The time the integration was updated.

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 a notifications integration

Delete a notifications integration for a project.

delete
/ v1 / projects / :project_id / notification-integrations / :id 
curl --request DELETE \
     --url https://api.flexstack.com/v1/projects/1C8xJnvSBaztoHyxcim7C4/notification-integrations/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

project_id
string
required

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

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.

API Reference

Explore the API reference by resource type

Post to