Update Workspace (API Explorer) | Astro API Reference

Platform API ReferenceOrganization
Platform API ReferenceAlerts
Platform API ReferenceOptions
- GETGet cluster options
- GETGet Deployment options
Platform API ReferenceCluster
Platform API ReferenceDeployment
Platform API ReferenceDeploy
Platform API ReferenceEnvironment
Platform API ReferenceNotification Channels
Platform API ReferenceWorkspace
IAM API ReferenceAuthorization
- GETList authorization permission groups
IAM API ReferenceAllowed IP Address Range
IAM API ReferenceInvite
- POSTCreate a user invitation
- DELDelete a user invite
IAM API ReferenceRole
IAM API ReferenceTeam
IAM API ReferenceAPI Token
IAM API ReferenceUser

Built with

POSThttps://api.astronomer.io/platform/v1beta1/organizations/organizationId/workspaces/workspaceId

Path Parameters

organizationIdstringRequired
workspaceIdstringRequired

Body Parameters

cicdEnforcedDefaultbooleanRequired
descriptionstringRequired
namestringRequired<=50 characters

View in API Reference

Request

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

Response

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