Sign in
Workspaces

Delete Workspace

Delete a workspace and all of its resources. This is a destructive operation that takes some time to complete.

Actual deletion of infrastructure resources associated with the workspace only occurs after a retention period. Once the retention period has expired, the workspace state transitions from DELETING to DELETED.

post/v2/workspace:delete

Query parameters

namestring required

Name of the workspace in which to perform the operation.

Name of the workspace in which to perform the operation.

Response

Successful Response

errorsstring[]

List of error messages associated with the resource.

internal_error_detailsstring[]

List of internal error messages associated with the errors field.

idstring int64 required

The unique identifier of the resource

created_atstring date-time required

The time at which the resource was created

created_bystring required

The ID of the user who created the resource

updated_atstring date-time required

The time at which the resource was last updated

updated_bystring required

The ID of the user who last updated the resource

namestring required
display_namestring required
state'PROVISIONING' | 'DELETING' | 'READY' | 'FAILED' required
picture_file_idstring int64 nullable required

Changes

No recorded changes to this endpoint across all 1 revision of this API.