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"
}
'
import requests

url = "https://api.example.com/v2/databases/{database}/tenants"

payload = { "name": "My Sandbox" }
headers = {
"cookie": "nile-auth.session-token=",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {cookie: 'nile-auth.session-token=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My Sandbox'})
};

fetch('https://api.example.com/v2/databases/{database}/tenants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/databases/{database}/tenants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My Sandbox'
]),
CURLOPT_COOKIE => "nile-auth.session-token=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v2/databases/{database}/tenants"

payload := strings.NewReader("{\n \"name\": \"My Sandbox\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("cookie", "nile-auth.session-token=")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v2/databases/{database}/tenants")
.header("cookie", "nile-auth.session-token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Sandbox\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/tenants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["cookie"] = 'nile-auth.session-token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Sandbox\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>"
}
"<string>"
This response has no body data.
This response has no body data.

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