Create a new workspace

POST

https://host.com/apis/entities/v2/workspaces

Create a new workspace.

The creator is automatically granted Admin role on the workspace. By default, this endpoint waits for the Admin role to propagate before returning. Use wait_role_propagation=false to skip waiting (useful for bulk operations).

Example:

POST /apis/entities/v2/workspaces
{
    "name": "ml-team",
    "description": "Machine Learning Team workspace"
}

Create a new workspace. The creator is automatically granted Admin role on the workspace. By default, this endpoint waits for the Admin role to propagate before returning. Use `wait_role_propagation=false` to skip waiting (useful for bulk operations). Example: ``` POST /apis/entities/v2/workspaces { "name": "ml-team", "description": "Machine Learning Team workspace" } ```

Query parameters

wait_role_propagationbooleanOptionalDefaults to true

If true, wait for Admin role to propagate before returning (default: true). Set to false for bulk operations.

Request

This endpoint expects an object.

namestringRequiredformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"

Workspace name (unique identifier). Name must start with a lowercase letter, be 2-63 characters, and contain only lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with a hyphen).

descriptionstringOptional

Optional description of the workspace

Response

Successful Response

idstring

System-generated UUID

namestring

Workspace name (user-provided)

created_atdatetime

Timestamp of workspace creation

updated_atdatetime

Timestamp of last workspace update

descriptionstring

Optional description

created_bystring

Principal id for workspace creator

updated_bystring

Principal id for last workspace update

Errors

422

Unprocessable Entity Error

$	curl -X POST https://host.com/apis/entities/v2/workspaces \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "data-science-team"
>	}'

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "data-science-team",
4	"created_at": "2024-01-15T09:30:00Z",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"description": "Workspace for the Data Science Team projects and collaboration",
7	"created_by": "user-12345",
8	"updated_by": "user-12345"
9	}