Skip to main content
GET
Check Name Availability

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

name
string
required

The name to check. Matching is case-insensitive.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9_]+$
Example:

"monthly_purchases"

Response

CheckNameAvailability 200 response

name
string
required

The name that was checked, as supplied by the caller.

Maximum string length: 256
Pattern: ^[a-zA-Z0-9_]+$
Example:

"monthly_purchases"

available
boolean
required

Whether the name is free to use for a new dataset, view, or access rule.

Example:

false

reserved_by
enum<string>

Present when available is false and the token has read access to every kind of object that can hold a name (datasets and views). A token missing one of those permissions never receives reserved_by, whatever kind holds the name, so the field's absence reveals nothing about the holder. It identifies the kind of object, never the object itself.

Available options:
dataset,
view,
access_rule