curl --request DELETE \
--url https://{controlPlaneURL}/api/svc/v1/workspaces/{id} \
--header 'Authorization: Bearer <token>'
{
"workspace": {
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"tenantName": "<string>",
"clusterId": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"environmentId": "<string>",
"manifest": {
"type": "workspace",
"cluster_fqn": "<string>",
"name": "<string>",
"environment_name": "<string>",
"labels": {},
"annotations": {},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"permissions": [
{
"resource_fqn": "<string>",
"resource_type": "<string>",
"role_id": "<string>"
}
]
},
"isSystemWs": true,
"createdBy": "<string>"
},
"message": "<string>"
}
Deletes the workspace with the given workspace ID.
curl --request DELETE \
--url https://{controlPlaneURL}/api/svc/v1/workspaces/{id} \
--header 'Authorization: Bearer <token>'
{
"workspace": {
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"tenantName": "<string>",
"clusterId": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"environmentId": "<string>",
"manifest": {
"type": "workspace",
"cluster_fqn": "<string>",
"name": "<string>",
"environment_name": "<string>",
"labels": {},
"annotations": {},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"permissions": [
{
"resource_fqn": "<string>",
"resource_type": "<string>",
"role_id": "<string>"
}
]
},
"isSystemWs": true,
"createdBy": "<string>"
},
"message": "<string>"
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Workspace id of the space
Successfully deletes the workspace and returns the workspace details along with a confirmation message.
The response is of type object
.
Was this page helpful?