Update Workspace | Astronomer Documentation

curl -X POST https://api.astronomer.io/platform/v1beta1/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"
  },
  "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

This endpoint expects an object.

cicdEnforcedDefaultbooleanRequired

Whether new Deployments enforce CI/CD deploys by default.

descriptionstringRequired

The Workspace's description.

namestringRequired<=50 characters

The Workspace's name.

Response

cicdEnforcedDefaultboolean

Whether CI/CD deploys are enforced by default.

createdAtdatetime

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.

updatedAtdatetime

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

createdByobjectOptional

descriptionstringOptional

The Workspace's description.

organizationNamestringOptional

The name of the Organization to which the Workspace belongs.

updatedByobjectOptional

Errors

400

Update Workspace Body Bad Request Error

401

Update Workspace Body Unauthorized Error

403

Update Workspace Body Forbidden Error

404

Update Workspace Body Not Found Error

500

Update Workspace Body Internal Server Error