config API
System Configuration¶
Runtime configuration toggles for system behavior. All endpoints require authentication and system-level scope.
POST /api/v1/config/cache¶
Auth: Required Scope: system-level
Toggle the Redis cache on or off.
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | Yes | true to enable, false to disable |
Example¶
curl -s -X POST "$API/api/v1/config/cache" \
-H "Content-Type: application/json" \
-H "X-API-Key: $KEY" \
-d '{"enabled": false}'
POST /api/v1/config/auto-pipeline¶
Auth: Required Scope: system-level
Toggle automatic processing pipeline trigger on file registration (disabled by default). When enabled, registering a video file automatically creates a monitor job and starts processing.
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | Yes | true to enable auto-pipeline, false to disable |
Example¶
# Enable auto-pipeline
curl -s -X POST "$API/api/v1/config/auto-pipeline" \
-H "Content-Type: application/json" \
-H "X-API-Key: $KEY" \
-d '{"enabled": true}'
# Disable auto-pipeline
curl -s -X POST "$API/api/v1/config/auto-pipeline" \
-H "Content-Type: application/json" \
-H "X-API-Key: $KEY" \
-d '{"enabled": false}'
POST /api/v1/config/watcher-auto-register¶
Auth: Required Scope: system-level
Toggle automatic registration of newly detected files in the watcher (disabled by default). When enabled, the file watcher automatically pre-processes and registers new files into the database.
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
enabled |
boolean | Yes | true to enable watcher auto-register, false to disable |
Example¶
# Enable watcher auto-register
curl -s -X POST "$API/api/v1/config/watcher-auto-register" \
-H "Content-Type: application/json" \
-H "X-API-Key: $KEY" \
-d '{"enabled": true}'
Updated: 2026-05-19 12:49:24
Version History¶
| Version | Date | Changes |
|---|---|---|
| 1.0 | 2026-10-24 | Initial documentation |