Endpoint

/v1/frozen/bridges/

GET

Lists every Frozen bridge on the cluster, in path order.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_frozen_bridges",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "Every Frozen bridge on the cluster, in path order.",
        "type": "object",
        "properties": {
          "filesystem_uuid": {
            "description": "The bridge's filesystem UUID.",
            "type": "string"
          },
          "mount_path": {
            "description": "Absolute path of the bridge's directory on the cluster, without a trailing slash.",
            "type": "string"
          },
          "allow_archived_metadata_changes": {
            "description": "Whether clients can change the metadata and named streams of a file that is frozen, offline or restoring; see the create request's field.",
            "type": "boolean"
          }
        }
      }
    }
  }
}

POST

Creates a Frozen bridge at `mount_path` over Azure storage that Qumulo has set aside for this cluster, and returns the bridge. File access across the cluster pauses briefly during this call while the cluster restarts its services, so create a bridge while clients are quiet. The bridge is listed as soon as the call returns, shortly before it can be used. Returns HTTP 400 if `mount_path` isn't absolute or already exists, or its parent isn't a directory or is inside another bridge; HTTP 409 if the cluster has as many bridges as it allows, no storage is ready for another Frozen bridge, or the bridge this call created was deleted before the call returned; HTTP 412 while the cluster's REST file IDs leave out the filesystem ID; HTTP 503 while the cluster is still preparing for bridges, which a retry shortly after clears, or if the storage set aside can't be used right now; and HTTP 404 if this cluster can't have Frozen bridges. For no storage ready, or storage that can't be used, contact Qumulo.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_frozen_bridge_request",
  "type": "object",
  "properties": {
    "mount_path": {
      "description": "Absolute path of the bridge's directory, which the create makes. Its parent must exist, and must not be inside another bridge.",
      "type": "string"
    },
    "allow_archived_metadata_changes": {
      "description": "When true, clients can change the metadata of a file that is frozen, offline or restoring: its mode, owner, group, ACL, times and DOS attributes, and its named streams. When false, every protocol and the REST API refuse those changes with access denied. Defaults to false, and can't be changed after creation.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code Description
201 Return value on success