Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
remote_mount_backends
Remote Mount Backends

Create Remote Mount Backend

Create Remote Mount Backend

post/remote_mount_backends

Response

The RemoteMountBackends object.

canary_file_pathstring

Path to the canary file used for health checks.

enabledboolean

True if this backend is enabled.

fallinteger

Number of consecutive failures before considering the backend unhealthy.

health_check_enabledboolean

True if health checks are enabled for this backend.

health_check_resultsobject[]

Array of recent health check results.

health_check_type'active' | 'passive'

Type of health check to perform.

idinteger

Unique identifier for this backend.

intervalinteger

Interval in seconds between health checks.

min_free_cpustring decimal

Minimum free CPU percentage required for this backend to be considered healthy.

min_free_memstring decimal

Minimum free memory percentage required for this backend to be considered healthy.

priorityinteger

Priority of this backend.

remote_pathstring

Path on the remote server to treat as the root of this mount.

remote_server_idinteger

The remote server that this backend is associated with.

remote_server_mount_idinteger

The mount ID of the Remote Server Mount that this backend is associated with.

riseinteger

Number of consecutive successes before considering the backend healthy.

status'healthy' | 'degraded' | 'failed' | 'desynced'

Status of this backend.

undergoing_maintenanceboolean

True if this backend is undergoing maintenance.

Example response

{
  "canary_file_path": "backend1.txt",
  "enabled": true,
  "fall": 1,
  "health_check_enabled": true,
  "health_check_results": [
    {
      "timestamp": "2025-09-19T12:32:52+00:00",
      "status": "healthy",
      "canary_timestamp": "2025-09-19T12:32:52+00:00"
    },
    {
      "status": "failed",
      "reason": "Unable to connect",
      "timestamp": "2025-09-19T12:32:52+00:00"
    }
  ],
  "health_check_type": "active",
  "id": 1,
  "interval": 60,
  "min_free_cpu": "1.0",
  "min_free_mem": "1.0",
  "priority": 1,
  "remote_path": "/path/on/remote",
  "remote_server_id": 1,
  "remote_server_mount_id": 1,
  "rise": 1,
  "status": "healthy"
}