---
title: "Get Restic Task Queue"
method: GET
path: "/api/clusters/{clusterName}/restic/task-queue"
tags: ["ClusterRestic"]
---

# Get Restic Task Queue

`GET /api/clusters/{clusterName}/restic/task-queue`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `Authorization`

Gets the restic task queue for the specified cluster.

## Path parameters

- `clusterName` string, required

## Headers

- `Authorization` string, required

## Response `200`

Task queue fetched

- BackupmgrResticTask[]
  - `backup_opt` BackupmgrResticBackupOption
    - `dir_path` string
    - `dry_run` boolean: Don't upload, just show what would be done
    - `exclude` string[]: Exclude patterns
    - `exclude_caches` boolean: Exclude cache directories
    - `exclude_file` string[]: Files containing exclude patterns
    - `exclude_if_present` string[]: Exclude dirs containing these files
    - `exclude_larger_than` string: Max file size (e.g., "100M")
    - `extra_paths` string[]: More paths in the same snapshot
    - `files_from` string[]: Read files to backup from file
    - `host` string: Override hostname
    - `ignore_ctime` boolean: Ignore ctime changes
    - `ignore_inode` boolean: Ignore inode changes
    - `one_file_system` boolean: Don't cross filesystem boundaries
    - `parent` string: Parent snapshot for incremental
    - `tags` string[]
    - `time` string: Backup timestamp (e.g., '2012-11-01 22:08:41')
  - `changepass_opt` BackupmgrResticChangePassOption
  - `check_opt` BackupmgrResticCheckOption
    - `check_unused` boolean: Check for unused blobs (removed in newer versions)
    - `read_data` boolean: Read all data blobs (slow, comprehensive)
    - `read_data_subset` string: Read subset of data (e.g., "10%", "5G", "1/5")
    - `with_cache` boolean: Use cache (default: false for check)
  - `fetch_opt` BackupmgrResticFetchOption
    - `skip_stats` boolean
  - `init_opt` BackupmgrResticInitOption
    - `allow_empty_prefix` boolean
    - `copy_chunker_params` boolean
    - `force` boolean
    - `from_repo` string
    - `repository_version` string: e.g., "stable", "latest", "1", "2"
  - `purge_opt` BackupmgrResticPurgeOption
    - `compact` boolean: Enable compact output during forget
    - `dry_run` boolean
    - `group_by` string
    - `host` string[]
    - `keep_daily` integer
    - `keep_hourly` integer
    - `keep_last` integer
    - `keep_monthly` integer
    - `keep_tag` string[]
    - `keep_weekly` integer
    - `keep_within` string
    - `keep_within_daily` string
    - `keep_within_hourly` string
    - `keep_within_monthly` string
    - `keep_within_weekly` string
    - `keep_within_yearly` string
    - `keep_yearly` integer
    - `path` string[]
    - `prune` boolean: When true, runs prune after forget to reclaim space (defaults to true via NewResticPurgeOption)
    - `prune_option` BackupmgrResticPruneOption
      - `max_repack_size` string: e.g., "500M", "5G". Empty means omit.
      - `max_unused` string: e.g., "500M", "5G". Empty means omit.
      - `repack_cacheable_only` boolean: Only repack cacheable blobs
      - `repack_small` boolean: Repack small blobs
      - `repack_uncompressed` boolean: Repack uncompressed blobs
    - `snapshot_id` string
    - `tag` string[]
  - `restore_opt` BackupmgrResticRestoreOption
    - `exclude` string[]: Exclude patterns
    - `global_opt` BackupmgrResticGlobalOption
      - `ca_cert` string
      - `cache_dir` string
      - `cleanup_cache` boolean
      - `compression` string
      - `insecure_tls` boolean
      - `json` boolean
      - `key_hint` string
      - `limit_download` integer
      - `limit_upload` integer
      - `no_cache` boolean
      - `no_lock` boolean
      - `option` string[]
      - `pack_size` integer
      - `password_command` string
      - `password_file` string
      - `quiet` boolean
      - `repo` string
      - `repository_file` string
      - `tls_client_cert` string
      - `verbose` integer
    - `host` string[]: Filter by host for "latest" snapshot
    - `iexclude` string[]: Case-insensitive exclude patterns
    - `iinclude` string[]: Case-insensitive include patterns
    - `include` string[]: Include patterns
    - `overwrite` string: Overwrite policy (non-standard, custom implementation)
    - `path` string[]: Filter by path for "latest" snapshot
    - `snapshot_id` string
    - `tag` string[]: Filter by tag for "latest" snapshot
    - `target_dir` string: Target directory for restore
    - `verify` boolean: Verify restored files content
  - `task_id` integer
  - `task_type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
  - `unlock_opt` BackupmgrResticUnlockOption
    - `remove_all` boolean: Remove all locks, including from other hosts

## Other responses

- `403`: No valid ACL
- `500`: No cluster

## Changes

- **2026-07-17** `7465ea0ee21a`: 1 info
  - endpoint added
- **2023-03-31** `b57fc7b9446e`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/changes/api/clusters/:clusterName/restic/task-queue/get.md)

---

[API](https://skmtc.dev/signal18/apis/signal-18-dashboard-api.md) - [All operations](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/revisions/8ee8a1e31294?raw)