---
title: "Toggle restic mount on/off"
method: POST
path: "/api/clusters/{clusterName}/actions/restic-mount-toggle"
tags: ["Restic"]
---

# Toggle restic mount on/off

`POST /api/clusters/{clusterName}/actions/restic-mount-toggle`

## Request

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

Mounts or unmounts the restic repository for the cluster. Mount is persistent until explicitly unmounted. Supports filtering by host, tag, path and various mount options.

## Path parameters

- `clusterName` string, required

## Headers

- `Authorization` string, required

## Request body

- ServerResticMountToggleRequest
  - `action` string: "mount" or "unmount"
  - `options` BackupmgrResticMountOption
    - `allow_other` boolean: Permission Options
    - `host` string[]: Snapshot Filters
    - `no_default_permissions` boolean: Ignore Unix permissions (--no-default-permissions)
    - `no_lock` boolean: Repository Options
    - `owner_root` boolean: Use root as owner (--owner-root)
    - `path` string[]: Filter by path(s) (--path)
    - `path_template` string[]: Path/Time Templates
    - `quiet` boolean: Quiet mode (-q, --quiet)
    - `tag` string[]: Filter by tag(s) (--tag)
    - `target_dir` string: Required
    - `time_template` string: Template for times (--time-template, default: "2006-01-02T15:04:05Z07:00")
    - `verbose` integer: Verbosity level (-v, --verbose, 0-3)

## Response `200`

Mount status after operation

- ServerResticMountStatusResponse
  - `active_users` string[]
  - `is_mounted` boolean
  - `mount_path` string
  - `ref_count` integer

## Other responses

- `400`: Invalid request
- `403`: No valid ACL
- `409`: Mount already active at different path
- `500`: Operation failed

## 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/actions/restic-mount-toggle/post.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)