Update Workspace | Astronomer Documentation

curl -X POST https://api.astronomer.io/v1/organizations/organizationId/workspaces/workspaceId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "cicdEnforcedDefault": true,
  "description": "This is a test workspace",
  "name": "My Workspace"
}'

{
  "cicdEnforcedDefault": true,
  "createdAt": "2023-09-08T12:00:00Z",
  "id": "clm8t5u4q000008jq4qoc3036",
  "name": "My Workspace",
  "organizationId": "clm8t5u4q000008jq4qoc3036",
  "updatedAt": "2023-09-08T13:30:00Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "defaultCloudProvider": "AWS",
  "defaultClusterId": "clmh9g6zj000008mg77if5wa2",
  "defaultRegion": "us-east-1",
  "description": "This is a test workspace",
  "organizationName": "My Organization",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

Update a Workspace.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

The ID of the Organization to which the Workspace belongs.

workspaceIdstringRequired

The Workspace's ID.

Request

The request body for updating a new Workspace.

cicdEnforcedDefaultbooleanRequired

Whether new Deployments enforce CI/CD deploys by default.

descriptionstringRequired

The Workspace's description.

namestringRequired<=50 characters

The Workspace's name.

defaultCloudProviderenumOptional

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

Allowed values:

defaultClusterIdstringOptional

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

defaultRegionstringOptional

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

Response

cicdEnforcedDefaultboolean

Whether CI/CD deploys are enforced by default.

createdAtstringformat: "date-time"

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

idstring

The Workspace's ID.

namestring

The Workspace's name.

organizationIdstring

The ID of the organization to which the workspace belongs.

updatedAtstringformat: "date-time"

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

createdByobject

defaultCloudProviderstring

The default cloud provider for new Deployments.

defaultClusterIdstring

The ID of the default cluster for new Deployments.

defaultRegionstring

The default region for new Deployments.

descriptionstring

The Workspace's description.

organizationNamestring

The name of the Organization to which the Workspace belongs.

updatedByobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error