Skip to main content
POST
Update Workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The ID of the Organization to which the Workspace belongs.

workspaceId
string
required

The Workspace's ID.

Body

application/json

The request body for updating a new Workspace.

cicdEnforcedDefault
boolean
required

Whether new Deployments enforce CI/CD deploys by default.

Example:

true

description
string
required

The Workspace's description.

Example:

"This is a test workspace"

name
string
required

The Workspace's name.

Maximum string length: 50
Example:

"My Workspace"

defaultCloudProvider
enum<string>

The default cloud provider for new Deployments. Must be provided together with defaultRegion. Mutually exclusive with defaultClusterId.

Available options:
AWS,
AZURE,
GCP
Example:

"AWS"

defaultClusterId
string

The ID of the default cluster for new Deployments. Mutually exclusive with defaultCloudProvider and defaultRegion.

Example:

"clmh9g6zj000008mg77if5wa2"

defaultRegion
string

The default region for new Deployments. Must be provided together with defaultCloudProvider. Mutually exclusive with defaultClusterId.

Example:

"us-east-1"

Response

OK

cicdEnforcedDefault
boolean
required

Whether CI/CD deploys are enforced by default.

Example:

true

createdAt
string<date-time>
required

The time when the Workspace was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

Example:

"2023-09-08T12:00:00Z"

id
string
required

The Workspace's ID.

Example:

"clm8t5u4q000008jq4qoc3036"

name
string
required

The Workspace's name.

Example:

"My Workspace"

organizationId
string
required

The ID of the organization to which the workspace belongs.

Example:

"clm8t5u4q000008jq4qoc3036"

updatedAt
string<date-time>
required

The time when the Workspace was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ

Example:

"2023-09-08T13:30:00Z"

createdBy
object
defaultCloudProvider
enum<string>

The default cloud provider for new Deployments.

Available options:
AWS,
AZURE,
GCP
Example:

"AWS"

defaultClusterId
string

The ID of the default cluster for new Deployments.

Example:

"clmh9g6zj000008mg77if5wa2"

defaultRegion
string

The default region for new Deployments.

Example:

"us-east-1"

description
string

The Workspace's description.

Example:

"This is a test workspace"

organizationName
string

The name of the Organization to which the Workspace belongs.

Example:

"My Organization"

updatedBy
object