Data Vault
Browse collections, query records, and manage schema in workspace-scoped customer data.
The Data Vault is your window into workspace customer data. All access flows through Control Plane to Dataplane — you never call Dataplane directly from the browser.
Who can access
| Action | Required permission |
|---|---|
| List collections / query records | read |
| Create / update / delete records | write |
| Create / drop collections (DDL) | ddl |
Prerequisites
- A workspace selected in the top navigation picker
- Dataplane provisioned for the workspace (setup card appears if not)
Browse collections
Open Data Vault
In the sidebar under Data, click Data Vault.
Select a workspace
Use the workspace picker in the top navigation bar if not already set.
Pick a collection
The left panel lists collections in the workspace. Click one to load its schema and records.
Query and filter records
The record browser supports:
- Pagination — 25 rows per page with next/previous controls
- Filter — substring match or JSON filter expression
- Sort — click a column header to sort ascending or descending
Create or edit records
Click New record
With a collection selected, click New record. Fill in fields per the collection schema.
Save
Submit to create. For existing rows, click the Edit action in the sticky actions column.
Manage schema (DDL)
Users with ddl permission can:
- Create collection — click New collection, define name and schema
- Edit collection — modify schema metadata
- Delete collection — removes the collection and its data (irreversible)
DDL operations are destructive when deleting collections. Confirm with your team before dropping production data.
Dataplane setup
If Dataplane is not yet provisioned, a Setup Dataplane card appears. Follow the on-page steps to generate a service API key (stored as a platform-managed secret).
Troubleshooting
| Problem | Likely cause | What to do |
|---|---|---|
| No collections | Empty workspace or Dataplane not ready | Complete Dataplane setup card |
| Query returns empty | Filter too strict | Clear filter; check sort direction |
| DDL buttons missing | No ddl permission | Ask a workspace admin |
| 403 on save | Missing write | Check your role on Members & Roles |
Related API
GET /v1/workspaces/{id}/vault/collections— list collectionsPOST /v1/workspaces/{id}/vault/collections/{name}/query— query recordsPOST /v1/workspaces/{id}/vault/collections/{name}/records— create record
See Shell Data Vault for federated app integration.