Skip to main content
POST
Check a Semantic Layer folder name
Folder names are unique among siblings. Ask before creating or renaming to avoid a 400: send the name and the parent it would live in (omit parent for the root).
available_name is the name itself when it is free, or the first free <name> N when it is not. The check counts every sibling, including folders the key cannot see, because they would still collide. A service account needs the Write the Semantic Layer capability, and parent must be in its scope.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

Answers "can I call it this?" AND "then what should I call it?".

The frontend calls this before opening the rename input, so the user is never bounced by a 400 they could not have predicted.

name
string
required
Maximum string length: 256
parent
string<uuid> | null

Response

200 - application/json

Answers "can I call it this?" AND "then what should I call it?".

The frontend calls this before opening the rename input, so the user is never bounced by a 400 they could not have predicted.

name
string
required
Maximum string length: 256
available
boolean
required
read-only
available_name
string
required
read-only
parent
string<uuid> | null