Delete Workspace

curl --request DELETE \
  --url 'https://api.usedatabrain.com/api/v2/workspace?name=sales-analytics' \
  --header 'Authorization: Bearer dbn_live_abc123...'

const workspaceName = 'sales-analytics';
const response = await fetch(
  `https://api.usedatabrain.com/api/v2/workspace?name=${encodeURIComponent(workspaceName)}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer dbn_live_abc123...',
    },
  }
);

const result = await response.json();
if (result.error) {
  console.error('Error:', result.error);
} else {
  console.log('Deleted workspace:', result.data);
}

import requests

url = "https://api.usedatabrain.com/api/v2/workspace"
headers = {"Authorization": "Bearer dbn_live_abc123..."}
params = {"name": "sales-analytics"}

response = requests.delete(url, headers=headers, params=params)
result = response.json()

if result.get("error"):
    print("Error:", result["error"])
else:
    print("Deleted workspace:", result.get("data"))

{
  "data": {
    "id": "sales-analytics",
    "message": "Workspace deleted successfully"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is not provided or Invalid!"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST_BODY",
    "message": "\"name\" is required"
  }
}

{
  "error": {
    "code": "WORKSPACE_ID_ERROR",
    "message": "invalid workspace name, workspace name not found"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is invalid or expired!"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "INTERNAL_SERVER_ERROR"
  }
}

curl --request DELETE \
  --url 'https://api.usedatabrain.com/api/v2/workspace?name=sales-analytics' \
  --header 'Authorization: Bearer dbn_live_abc123...'

const workspaceName = 'sales-analytics';
const response = await fetch(
  `https://api.usedatabrain.com/api/v2/workspace?name=${encodeURIComponent(workspaceName)}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer dbn_live_abc123...',
    },
  }
);

const result = await response.json();
if (result.error) {
  console.error('Error:', result.error);
} else {
  console.log('Deleted workspace:', result.data);
}

import requests

url = "https://api.usedatabrain.com/api/v2/workspace"
headers = {"Authorization": "Bearer dbn_live_abc123..."}
params = {"name": "sales-analytics"}

response = requests.delete(url, headers=headers, params=params)
result = response.json()

if result.get("error"):
    print("Error:", result["error"])
else:
    print("Deleted workspace:", result.get("data"))

{
  "data": {
    "id": "sales-analytics",
    "message": "Workspace deleted successfully"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is not provided or Invalid!"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST_BODY",
    "message": "\"name\" is required"
  }
}

{
  "error": {
    "code": "WORKSPACE_ID_ERROR",
    "message": "invalid workspace name, workspace name not found"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is invalid or expired!"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "INTERNAL_SERVER_ERROR"
  }
}

curl --request DELETE \
  --url 'https://api.usedatabrain.com/api/v2/workspace?name=sales-analytics' \
  --header 'Authorization: Bearer dbn_live_abc123...'

const workspaceName = 'sales-analytics';
const response = await fetch(
  `https://api.usedatabrain.com/api/v2/workspace?name=${encodeURIComponent(workspaceName)}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer dbn_live_abc123...',
    },
  }
);

const result = await response.json();
if (result.error) {
  console.error('Error:', result.error);
} else {
  console.log('Deleted workspace:', result.data);
}

import requests

url = "https://api.usedatabrain.com/api/v2/workspace"
headers = {"Authorization": "Bearer dbn_live_abc123..."}
params = {"name": "sales-analytics"}

response = requests.delete(url, headers=headers, params=params)
result = response.json()

if result.get("error"):
    print("Error:", result["error"])
else:
    print("Deleted workspace:", result.get("data"))

{
  "data": {
    "id": "sales-analytics",
    "message": "Workspace deleted successfully"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is not provided or Invalid!"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST_BODY",
    "message": "\"name\" is required"
  }
}

{
  "error": {
    "code": "WORKSPACE_ID_ERROR",
    "message": "invalid workspace name, workspace name not found"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is invalid or expired!"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "INTERNAL_SERVER_ERROR"
  }
}

DELETE

api

workspace

curl --request DELETE \
  --url 'https://api.usedatabrain.com/api/v2/workspace?name=sales-analytics' \
  --header 'Authorization: Bearer dbn_live_abc123...'

const workspaceName = 'sales-analytics';
const response = await fetch(
  `https://api.usedatabrain.com/api/v2/workspace?name=${encodeURIComponent(workspaceName)}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer dbn_live_abc123...',
    },
  }
);

const result = await response.json();
if (result.error) {
  console.error('Error:', result.error);
} else {
  console.log('Deleted workspace:', result.data);
}

import requests

url = "https://api.usedatabrain.com/api/v2/workspace"
headers = {"Authorization": "Bearer dbn_live_abc123..."}
params = {"name": "sales-analytics"}

response = requests.delete(url, headers=headers, params=params)
result = response.json()

if result.get("error"):
    print("Error:", result["error"])
else:
    print("Deleted workspace:", result.get("data"))

{
  "data": {
    "id": "sales-analytics",
    "message": "Workspace deleted successfully"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is not provided or Invalid!"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST_BODY",
    "message": "\"name\" is required"
  }
}

{
  "error": {
    "code": "WORKSPACE_ID_ERROR",
    "message": "invalid workspace name, workspace name not found"
  }
}

{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "API Key is invalid or expired!"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "INTERNAL_SERVER_ERROR"
  }
}

Permanently delete a workspace. The workspace is identified by the name query parameter. The payload is validated with name: required string (Joi.string().required()).

This action is irreversible. Ensure no dashboards, metrics, or embeds still depend on this workspace before deleting it.

Endpoint

DELETE https://api.usedatabrain.com/api/v2/workspace?name={name}

Self-hosted Databrain Endpoint

DELETE <SELF_HOSTED_URL>/api/v2/workspace?name={name}

Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:

In Settings page, navigate to the Service Tokens section.
Click the “Generate Token” button to create a new service token if you don’t have one already.

Use this token as the Bearer value in your Authorization header.

Headers

Authorization

string

required

Bearer token for API authentication. Use your service token.

Authorization: Bearer dbn_live_abc123...

Query Parameters

name

string

required

Workspace name to delete. Must match an existing workspace in your organization (case-sensitive, same string as returned by list/create).If name is omitted, validation fails with INVALID_REQUEST_BODY and the Joi validation message (for example "name" is required).

Show Finding workspace names

Use the List Workspaces API to list workspace names
Use the same value as in Create Workspace / Update Workspace

Response

On success, the API returns a top-level data object (same shape as other /api/v2/workspace handlers).

data

object

Show data properties

string

Set to the workspace name that was deleted (string echoed from the query parameter).

message

string

Success message: Workspace deleted successfully.

error

null | object

On success, error is omitted or null. On failure, contains code and message (see examples below).

Examples

HTTP Status Code Summary

Status Code	Description
`200`	OK — Workspace deleted successfully
`400`	Bad Request — Missing/invalid API key (middleware), Joi validation failed, or workspace not found
`401`	Unauthorized — Invalid/expired token or missing required scopes (middleware)
`500`	Internal Server Error — Delete mutation failed or unexpected error

Possible Errors

Error code	HTTP status	When it occurs
`AUTHENTICATION_ERROR`	400	Authorization missing or malformed (`isPrivateApp` middleware)
`INVALID_REQUEST_BODY`	400	`deleteWorkspaceSchema` validation failed (e.g. missing `name`)
`WORKSPACE_ID_ERROR`	400	No workspace with that `name` for your company
`AUTHENTICATION_ERROR`	401	Service token invalid, expired, or missing required scopes
`INTERNAL_SERVER_ERROR`	500	Delete mutation returned no row, GraphQL error, or handler catch

Next Steps

List Workspaces

List remaining workspaces in your organization

Create Workspace

Create a new workspace after deletion

Update Workspace

Update workspace settings instead of deleting

Update Workspace Dashboards

Embedding APIs

Authentication

Datasource APIs

Datamart APIs

Semantic Layer APIs

Workspace APIs

Embeds

Data App APIs

Metric APIs

Self-Hosted APIs

Endpoint

Self-hosted Databrain Endpoint

Authentication

Headers

Query Parameters

Response

Examples

HTTP Status Code Summary

Possible Errors

Next Steps

List Workspaces

Create Workspace

Update Workspace

​Endpoint

​Self-hosted Databrain Endpoint

​Authentication

​Headers

​Query Parameters

​Response

​Examples

​HTTP Status Code Summary

​Possible Errors

​Next Steps

List Workspaces

Create Workspace

Update Workspace

Endpoint

Self-hosted Databrain Endpoint

Authentication

Headers

Query Parameters

Response

Examples

HTTP Status Code Summary

Possible Errors

Next Steps