Skip to main content
PUT
/
watch-folders
/
{watch_folder_id}
Update a watch folder
curl --request PUT \
  --url http://localhost:6699/api/v1/watch-folders/{watch_folder_id} \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "enabled": true,
  "enable_visual_analysis": true,
  "enable_audio_analysis": true,
  "enable_face_analysis": true,
  "audio_language": "<string>",
  "cluster_job_name": "<string>",
  "face_eps": 123,
  "face_min_samples": 123,
  "cache_dir": "<string>",
  "excluded_extensions": [
    "<string>"
  ],
  "excluded_filename_globs": [
    "<string>"
  ],
  "excluded_folder_globs": [
    "<string>"
  ]
}
'
import requests

url = "http://localhost:6699/api/v1/watch-folders/{watch_folder_id}"

payload = {
    "enabled": True,
    "enable_visual_analysis": True,
    "enable_audio_analysis": True,
    "enable_face_analysis": True,
    "audio_language": "<string>",
    "cluster_job_name": "<string>",
    "face_eps": 123,
    "face_min_samples": 123,
    "cache_dir": "<string>",
    "excluded_extensions": ["<string>"],
    "excluded_filename_globs": ["<string>"],
    "excluded_folder_globs": ["<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({
    enabled: true,
    enable_visual_analysis: true,
    enable_audio_analysis: true,
    enable_face_analysis: true,
    audio_language: '<string>',
    cluster_job_name: '<string>',
    face_eps: 123,
    face_min_samples: 123,
    cache_dir: '<string>',
    excluded_extensions: ['<string>'],
    excluded_filename_globs: ['<string>'],
    excluded_folder_globs: ['<string>']
  })
};

fetch('http://localhost:6699/api/v1/watch-folders/{watch_folder_id}', 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/watch-folders/{watch_folder_id}",
  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([
    'enabled' => true,
    'enable_visual_analysis' => true,
    'enable_audio_analysis' => true,
    'enable_face_analysis' => true,
    'audio_language' => '<string>',
    'cluster_job_name' => '<string>',
    'face_eps' => 123,
    'face_min_samples' => 123,
    'cache_dir' => '<string>',
    'excluded_extensions' => [
        '<string>'
    ],
    'excluded_filename_globs' => [
        '<string>'
    ],
    'excluded_folder_globs' => [
        '<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/watch-folders/{watch_folder_id}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"enable_visual_analysis\": true,\n  \"enable_audio_analysis\": true,\n  \"enable_face_analysis\": true,\n  \"audio_language\": \"<string>\",\n  \"cluster_job_name\": \"<string>\",\n  \"face_eps\": 123,\n  \"face_min_samples\": 123,\n  \"cache_dir\": \"<string>\",\n  \"excluded_extensions\": [\n    \"<string>\"\n  ],\n  \"excluded_filename_globs\": [\n    \"<string>\"\n  ],\n  \"excluded_folder_globs\": [\n    \"<string>\"\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/watch-folders/{watch_folder_id}")
  .header("X-License-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"enable_visual_analysis\": true,\n  \"enable_audio_analysis\": true,\n  \"enable_face_analysis\": true,\n  \"audio_language\": \"<string>\",\n  \"cluster_job_name\": \"<string>\",\n  \"face_eps\": 123,\n  \"face_min_samples\": 123,\n  \"cache_dir\": \"<string>\",\n  \"excluded_extensions\": [\n    \"<string>\"\n  ],\n  \"excluded_filename_globs\": [\n    \"<string>\"\n  ],\n  \"excluded_folder_globs\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:6699/api/v1/watch-folders/{watch_folder_id}")

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  \"enabled\": true,\n  \"enable_visual_analysis\": true,\n  \"enable_audio_analysis\": true,\n  \"enable_face_analysis\": true,\n  \"audio_language\": \"<string>\",\n  \"cluster_job_name\": \"<string>\",\n  \"face_eps\": 123,\n  \"face_min_samples\": 123,\n  \"cache_dir\": \"<string>\",\n  \"excluded_extensions\": [\n    \"<string>\"\n  ],\n  \"excluded_filename_globs\": [\n    \"<string>\"\n  ],\n  \"excluded_folder_globs\": [\n    \"<string>\"\n  ]\n}"

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

Authorizations

X-License-Key
string
header
required

Jumper Pro license key passed via header

Path Parameters

watch_folder_id
string
required

Body

application/json
enabled
boolean
enable_visual_analysis
boolean
enable_audio_analysis
boolean
enable_face_analysis
boolean
audio_language
string
cluster_job_name
string
face_eps
number
face_min_samples
integer
cache_dir
string
excluded_extensions
string[]
excluded_filename_globs
string[]
excluded_folder_globs
string[]

Response

Watch folder updated

Last modified on July 1, 2026