Scan or execute cleanup of stale configs

POST

/arr/cleanup

curl --request POST \
  --url https://example.com/api/v1/arr/cleanup \
  --header 'Content-Type: application/json' \
  --data '{ "instanceId": 1, "action": "scan" }'

• API v1

Detects and deletes stale namespace-suffixed custom formats and quality profiles from an Arr instance that are no longer in the current sync selections.

Two actions are supported via the action field in the request body:

• scan: Scans for stale items and returns what would be deleted.
• execute: Deletes the stale items from a previous scan result.

Quality profiles assigned to media will be skipped with a warning (Arr returns HTTP 500 “in use”).

Request Body^required

Media typeapplication/json

One of:

object

object

instanceId

required

Arr instance ID

integer

action

required

string

Allowed values: scan

object

object

instanceId

required

Arr instance ID

integer

action

required

string

Allowed values: execute

scanResult

required

object

staleCustomFormats

required

Custom formats that are no longer in sync selections

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

staleQualityProfiles

required

Quality profiles that are no longer in sync selections

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

Responses

200

Scan or delete result

Media typeapplication/json

One of:

object

object

staleCustomFormats

required

Custom formats that are no longer in sync selections

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

staleQualityProfiles

required

Quality profiles that are no longer in sync selections

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

object

object

deletedCustomFormats

required

Custom formats that were successfully deleted

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

deletedQualityProfiles

required

Quality profiles that were successfully deleted

Array<object>

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

skippedQualityProfiles

required

Quality profiles that were skipped (assigned to media)

Array<object>

object

item

required

object

id

required

Arr entity ID

integer

name

required

Full name including namespace suffix

string

strippedName

required

Name with namespace suffix removed

string

reason

required

Why the item was skipped (e.g. “Profile is assigned to media”)

string

Example^generated

{
  "staleCustomFormats": [
    {
      "id": 1,
      "name": "example",
      "strippedName": "example"
    }
  ],
  "staleQualityProfiles": [
    {
      "id": 1,
      "name": "example",
      "strippedName": "example"
    }
  ]
}

400

Invalid request (missing instanceId, invalid action)

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Instance not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to perform cleanup

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}