Updated on 2025-02-25 GMT+08:00

Deleting a Workspace

Function

This API is used to delete workspaces.

URI

DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

workspace_id

Yes

String

Workspace ID. For how to obtain it, see Obtaining a Workspace ID.

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Obtain a user token by calling IAM's API. X-Subject-Token in the response header is the desired user token. For how to obtain a token, see Authentication.

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

message

String

Message content of the general Message structure.

Example Request

Delete a workspace under a project.

/v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id}

Example Response

{
    "status_code": 200,
    "message": null,
    "is_success": true
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.