DeleteWorkspace

Updated at:
Copy as MD

Deletes a workspace that is no longer in use and ends the management lifecycle of the workspace.

Operation description

Deletes a workspace that is no longer in use and ends the management lifecycle of the workspace.

If you repeatedly delete the same workspace that is in the Deleting or Deleted state, the API operation processes the request based on idempotence.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

agentcore:DeleteWorkspace

delete

*Workspace

acs:agentcore:{#regionId}:{#accountId}:workspace/{#WorkspaceId}

None None

Request syntax

DELETE /workspaces/{workspaceId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The ID of the workspace to be deleted.

ws-123456

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

The response for deleting a workspace.

requestId

string

The request ID.

request-123456

message

string

The response message.

success

httpStatusCode

integer

The HTTP status code.

200

code

string

The business status code.

SUCCESS

success

boolean

Indicates whether the request is successful.

true

data

object

The result of the deletion request.

workspaceId

string

The workspace ID.

ws-123456

Examples

Success response

JSON format

{
  "requestId": "request-123456",
  "message": "success",
  "httpStatusCode": 200,
  "code": "SUCCESS",
  "success": true,
  "data": {
    "workspaceId": "ws-123456"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified request parameter is invalid.
404 Resource.NotFound The specified AgentCore workspace does not exist.
409 Operation.Conflict The workspace is not in a state that permits this operation.
409 Resource.InUse The workspace still contains agents, MCP servers, or model connections and cannot be deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.