Skip to main content
POST
/
v2
/
databases
/
{database}
/
tenants
creates a tenant
curl --request POST \
  --url https://api.example.com/v2/databases/{database}/tenants \
  --header 'Content-Type: application/json' \
  --cookie nile-auth.session-token= \
  --data '
{
  "name": "My Sandbox"
}
'
{
  "id": "<string>",
  "name": "<string>"
}

Authorizations

nile-auth.session-token
string
cookie
required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

database
string
required

Body

application/json

A wrapper for the tenant name.

name
string
required
id
string

The desired uuidv7 of the tenant

Response

A created tenants

id
string
required
name
string