cleanuparr_arr_download_clients
Create, update, delete, list, and test download clients in Cleanuparr to control and monitor your automation setup.
Instructions
cleanuparr arr download clients operations on Cleanuparr. Pass operation and an arguments dict matching that operation's parameters.
cleanuparr_create_arr_instance(arr_type, instance) — Create an *arr instance. DTO fields: enabled, name, url, apiKey, version, externalUrl.
cleanuparr_create_download_client(client) — Create a download client. DTO includes enabled, name, typeName, type, host, username, password, urlBase, externalUrl, and directory source/target.
cleanuparr_delete_arr_instance(arr_type, instance_id) — Delete an *arr instance by GUID.
cleanuparr_delete_download_client(client_id) — Delete a download client by GUID.
cleanuparr_get_arr_config(arr_type) —
cleanuparr_get_general_config() — Get general configuration, including dry-run and auth settings.
cleanuparr_list_arr_instances(arr_type) —
cleanuparr_list_download_clients() — List configured download clients.
cleanuparr_purge_strikes() — Purge all stored strikes. This is irreversible.
cleanuparr_test_arr_instance(arr_type, instance) — Test an *arr connection. DTO fields: url, apiKey, version, optional instanceId.
cleanuparr_test_download_client(client) — Test a download client. DTO includes typeName, type, host, credentials, urlBase, and optional clientId.
cleanuparr_update_arr_config(arr_type, config) — Replace one *arr config, normally containing failedImportMaxStrikes.
cleanuparr_update_arr_instance(arr_type, instance_id, instance) — Replace an *arr instance. Use Cleanuparr's secret placeholder for apiKey.
cleanuparr_update_download_client(client_id, client) — Replace a download client. Use the secret placeholder for password.
cleanuparr_update_general_config(config) — Merge fields into the current general config and PUT the result. A raw PUT replaces the whole resource, so sending only changed fields (e.g.
{"dryRun": false}) resets every unspecified field — includingdisplaySupportBannerand theauthobject — to defaults. This read-modify-write preserves current values for anything not inconfig. Fields include dryRun, retry/timeout settings, ignoredDownloads, connectivity, retention, log, and auth objects.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | ||
| operation | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |