Create a folder

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/folders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parentId": 123,
  "position": 123
}
'

{
  "createdAt": "2023-12-25",
  "deploymentId": 123,
  "id": 123,
  "name": "<string>",
  "position": 123,
  "updatedAt": "2023-12-25",
  "createdBy": 123,
  "parentId": 123,
  "updatedBy": 123
}

Folders

Create a folder

Create a new folder in a deployment’s workspace.

Provide a name, and optionally a parentId to nest the folder inside an existing one (omit it to create the folder at the workspace root). An optional position controls the folder’s ordering among its siblings.

Requires the AI BI User role (or higher). When parentId is set, the caller must additionally have edit or manage access to that parent folder.

Folders can be nested up to a fixed maximum depth; exceeding it returns 400.

POST

deployments

{deploymentId}

folders

Create a folder

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/folders \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parentId": 123,
  "position": 123
}
'

{
  "createdAt": "2023-12-25",
  "deploymentId": 123,
  "id": 123,
  "name": "<string>",
  "position": 123,
  "updatedAt": "2023-12-25",
  "createdBy": 123,
  "parentId": 123,
  "updatedBy": 123
}

Authorizations

Authorization

string

header

required

API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.

Path Parameters

deploymentId

number

required

Body

application/json

CreateFolderInput

name

string

required

Maximum string length: 255

parentId

integer | null

position

integer | null

Response

200 - application/json

createdAt

required

deploymentId

integer

required

integer

required

name

string

required

position

integer

required

type

enum<string>

required

Available options:

FOLDER,

WORKBOOK,

REPORT

updatedAt

required

createdBy

integer

parentId

integer | null

updatedBy

integer | null

List folders Update a folder

⌘I