Delete a workspace
Delete a workspace. The workspace is soft-deleted (archived) and no longer appears in reads;
the response returns the archived workspace. The workspace is identified by the
workspace_id path parameter alone; the x-hh-workspace-id header does not participate.
Deleting a workspace also archives every project inside it, so the events, datasets,
and evaluations in those projects are no longer reachable. Because that reaches well
beyond the resource named in the URL, a workspace that still has active projects is
rejected with a 409 unless the request sets dangerously_delete_child_scopes=true.
Projects that were already archived do not count, so a workspace emptied one project at a
time deletes without the flag.
The response describes only the workspace. It does not enumerate the projects archived alongside it, so read them first if you need that list.
Authorizations
A fine-grained control-plane API key (values begin with hh_fgcp_). Project API keys used with the Data Plane API will not work here. Create one in the HoneyHive app under an organization's or workspace's Settings → API Keys.
Path Parameters
The unique identifier of the workspace to delete
Query Parameters
Archive the workspace even when it still has active projects, archiving those projects too. Without it, such a request fails with a 409 and no changes are made.