Skip to main content
PUT
/
faces
/
clusters
/
names
Rename clusters
curl --request PUT \
  --url http://localhost:6699/api/v1/faces/clusters/names \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "<string>",
  "cluster_job_name": "<string>",
  "assignments": [
    {
      "cluster_id": "<string>",
      "name": "<string>"
    }
  ]
}
'
import requests

url = "http://localhost:6699/api/v1/faces/clusters/names"

payload = {
"cache_dir": "<string>",
"cluster_job_name": "<string>",
"assignments": [
{
"cluster_id": "<string>",
"name": "<string>"
}
]
}
headers = {
"X-License-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cache_dir: '<string>',
cluster_job_name: '<string>',
assignments: [{cluster_id: '<string>', name: '<string>'}]
})
};

fetch('http://localhost:6699/api/v1/faces/clusters/names', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "6699",
CURLOPT_URL => "http://localhost:6699/api/v1/faces/clusters/names",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cache_dir' => '<string>',
'cluster_job_name' => '<string>',
'assignments' => [
[
'cluster_id' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-License-Key: <api-key>"
],
]);

$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 := "http://localhost:6699/api/v1/faces/clusters/names"

payload := strings.NewReader("{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"assignments\": [\n {\n \"cluster_id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")

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

req.Header.Add("X-License-Key", "<api-key>")
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.put("http://localhost:6699/api/v1/faces/clusters/names")
.header("X-License-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"assignments\": [\n {\n \"cluster_id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:6699/api/v1/faces/clusters/names")

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

request = Net::HTTP::Put.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cache_dir\": \"<string>\",\n \"cluster_job_name\": \"<string>\",\n \"assignments\": [\n {\n \"cluster_id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "updated": 123,
  "changes": {}
}

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Body

application/json
cache_dir
string
required
cluster_job_name
string
required
assignments
object[]
required

Response

200 - application/json

Names updated

updated
integer

Number of clusters renamed

changes
object

Map of cluster_id to new name

Last modified on July 1, 2026