Skip to content

Feature/workspace custom #12713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nicklas-dohrn wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Feature/workspace custom #12713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5696df
docs: document custom Workspace ID field in create workspace guide
nicklas-dohrn Jun 29, 2026
ca4492a
docs: add custom workspace ID parameter to Create Workspaces API
nicklas-dohrn Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _dashboards/workspace/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ The following table lists the available path parameters.
| Parameter | Data type | Required | Description |
| :--- | :--- | :--- | :--- |
| `attributes` | Object | Required | Defines the workspace attributes. |
| `attributes.id` | String | Optional | The ID of the workspace. |
| `permissions` | Object | Optional | Specifies the permissions for the workspace. |
| `settings` | Object | Optional | Specifies the settings for the workspace. |

Expand All @@ -132,6 +133,7 @@ curl -k -XPOST "https://localhost:5601/api/workspaces" \
-H "osd-xsrf: true" \
-d '{
"attributes": {
"id": "my_workspace",
"name": "test4",
"description": "test4",
"features": ["use-case-all"]
Expand Down
3 changes: 2 additions & 1 deletion _dashboards/workspace/create-workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ To create a workspace, follow these steps:
- **Use case and features** is required. Choose the use case that best fits your needs. If you are using Amazon OpenSearch Serverless and have enabled the [multiple data sources]({{site.url}}{{site.baseurl}}/dashboards/management/data-sources/) feature, **Essentials** is automatically assigned.
4. (Optional) Select the color picker to customize the color of your workspace icon.
5. (Optional) Add a workspace description of up to 200 characters. This option is disabled when the description exceeds the character limit.
6. Save your workspace.
6. (Optional) Enter a custom **Workspace ID**. If left blank, an ID is auto-generated. A custom ID must be either a UUID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`) or 6–20 characters using only letters, numbers, underscores (`_`), and hyphens (`-`). If a workspace with the provided ID already exists, an error is returned.
7. Save your workspace.
- The **Create workspace** button becomes active once you enter the information for all required fields. You become the workspace owner automatically. The system redirects you to either the collaborators page if the saved objects permission is enabled or the overview page if the saved objects permission is disabled. See [Configuring dashboard admin]({{site.url}}{{site.baseurl}}/dashboards/workspace/workspace-acl/#configuring-dashboard-administrators) for more information about permissions.

To set up permissions, see [Workspace access control lists]({{site.url}}{{site.baseurl}}/dashboards/workspace/workspace-acl/) for more information.
Expand Down