Skip to main content

​
Properties

​
description?

optional description?: string

​
Description

Workspace description

​
name

name: string

​
Description

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.

​
slug?

optional slug?: string

​
Description

Globally unique identifier for the workspace, letters, digits and underscores only. Omit it and the server derives one from the name with a random suffix appended. Supply it when the identifier has to match a value maintained outside HoneyHive, such as an identity provider group that grants access to this workspace. A slug already in use returns 409.

​
virtual_dataplane_id

virtual_dataplane_id: string

​
Description

The unique identifier of the virtual data plane the workspace is created in

​
workspace_creator?

optional workspace_creator?: string
Format: email

​
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.