Create a workspace
Create a workspace in a virtual data plane. The parent virtual data plane is identified by
the virtual_dataplane_id path parameter alone; the x-hh-dataplane-id header does not
participate. Your organization’s virtual data plane ids are listed on the API keys page of
your organization settings in the HoneyHive app. Most organizations have exactly one.
The new workspace contains no projects. Create one with
POST /v1/workspaces/{workspace_id}/projects if you need it, because a workspace with no
projects has nowhere to log events.
The optional workspace_creator field names the user (by email) who receives the
workspace-creator membership on the new workspace. The named user must already be a member
of the virtual data plane. When omitted, the workspace is created without any membership.
The field is only accepted on API-key-initiated requests. User-initiated creation always
makes the calling user the creator, so sending the field returns a 400.
The roles that membership carries come from your organization’s role configuration. An organization that grants no role on workspace creation is a supported case: the request still succeeds and the named user receives no access. A 200 response is not by itself confirmation that the named user was granted anything.
A workspace_creator who is already signed in does not see the new workspace immediately.
A session captures its scope tree and permission grants when it is created, so a membership
granted afterwards is not reflected in it. Creating the workspace marks that user’s sessions
for refresh, and the refresh takes effect on their next request to the control plane, so an
idle browser tab may need a page reload.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the virtual data plane the workspace is created in
Body
Request body for creating a workspace
Workspace display name. Allowed characters are letters, digits, space, underscore, hyphen, apostrophe and ampersand. The name must contain at least one letter or digit, and must not start with a space.
200Workspace description
Email of the user to grant the workspace-creator membership to (API key actors only). A signed-in user does not see the new workspace until their session refreshes, which happens on their next request to the control plane.