Skip to main content
POST
/
api
/
v1
/
local
/
namespace
Create namespace
curl --request POST \
  --url https://api.example.com/api/v1/local/namespace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "deleteOnLastSessionExit": true,
  "annotations": {}
}
'
import requests

url = "https://api.example.com/api/v1/local/namespace"

payload = {
    "name": "<string>",
    "deleteOnLastSessionExit": True,
    "annotations": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', deleteOnLastSessionExit: true, annotations: {}})
};

fetch('https://api.example.com/api/v1/local/namespace', 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/api/v1/local/namespace",
  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' => '<string>',
    'deleteOnLastSessionExit' => true,
    'annotations' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/api/v1/local/namespace"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"deleteOnLastSessionExit\": true,\n  \"annotations\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <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/api/v1/local/namespace")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"deleteOnLastSessionExit\": true,\n  \"annotations\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/local/namespace")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"deleteOnLastSessionExit\": true,\n  \"annotations\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>"
}
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Namespace settings

​
name
string
required

The name of this namespace

​
deleteOnLastSessionExit
boolean
required
If this is true the namespace will be deleted when the last session in this namespace closes.  Note that this
    does not guarantee that the namespace will never be empty, because namespaces can be created without sessions
​
annotations
LinkedHashMap<String,String> · object
required

Response

Success