Update a workspace

put

https://{hostname}/delivery-manager/v1/workspaces/{workspaceName}

This operation modifies the description and group assignments for an existing workspace. Once you set the productId, version, and contractId fields when creating a workspace, you can't change them. To rename your workspace, run a separate POST operation.

Path Params

workspaceName

string

required

Name of the workspace that unifies all resources for your application or service. You can rename the workspace with a separate operation after you initially create the resource.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Request body for updating a workspace.

additionalGroupIds

array of strings

length ≥ 0

Additional groups provide a mechanism for cross-team collaboration. You can create these groups in Identity and Access Management to grant fine-grained, functional access to secondary teams. These teams can then interact with, view, or test specific components, such as individual environments or rule sets, without owning the underlying infrastructure.

additionalGroupIds

defaultGroupId

string

required

^[0-9]+$

A unique identifier for a group that controls access to workspace components. You configure groups in Identity and Access Management.

description

string

length ≤ 4000

Additional description for the workspace.

displayName

string

Name of the workspace visible in the Control Center application. You can change this value without affecting the workspaceName.

tags

Headers

If-Match

string

^(\\W)?"

This header prevents accidental overwrites and conflicts by making requests conditional. When you pass in a resource's ETag as an If-Match test, the update succeeds only if the resource hasn't changed. If the current ETag doesn't match and the data has changed, the server responds with a 412 error. See the Concurrency control section for more details.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response reflects the updated workspace.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

413Request entity too large.

415Unsupported media type.

429Too many requests.

500Internal server error.