Endpoint

/v1/object-portal/bridges/{filesystem_uuid}

GET

Returns the full configuration of the bridge with the given filesystem UUID, whatever its license or storage layout. A bridge answers as soon as its creation commits, before the quorum restart that joins its filesystem. A UUID naming no bridge, or one that is malformed, answers with HTTP 404. A bridge whose configuration or mount point cannot be read answers with HTTP 500. No credential material is ever returned.

Parameters

Name Description Required
filesystem_uuid Bridge filesystem UUID Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_object_bridge",
  "type": "object",
  "properties": {
    "filesystem_uuid": {
      "description": "Filesystem UUID of the bridge",
      "type": "string"
    },
    "mount_path": {
      "description": "Absolute path in the primary filesystem where the bridge is mounted, written without a trailing slash.",
      "type": "string"
    },
    "bucket_uri": {
      "description": "Full URI of the bridge's bucket.",
      "type": "string"
    },
    "key_prefix": {
      "description": "Prefix inside the bucket the bridge serves. Absent when the bridge serves the whole bucket.",
      "type": "string"
    },
    "delimiter": {
      "description": "Object-key separator the bridge projects directories from.",
      "type": "string"
    },
    "key_vault_hostname": {
      "description": "Azure Key Vault hostname the bridge fetches SAS tokens from. Absent unless the bucket is reached through a key vault.",
      "type": "string"
    },
    "notification_queue_url": {
      "description": "Queue URL the bridge polls for bucket-side change notifications. Absent when the bridge has none.",
      "type": "string"
    },
    "protocol_access": {
      "type": "string",
      "enum": [
        "READ_WRITE_EXPORT",
        "READ_ONLY"
      ],
      "description": "Whether protocol front doors may change the bridge filesystem's data and namespace.:\n * `READ_ONLY` - BRIDGE_PROTOCOL_READ_ONLY,\n * `READ_WRITE_EXPORT` - BRIDGE_PROTOCOL_READ_WRITE_EXPORT"
    },
    "metadata_import": {
      "type": "string",
      "enum": [
        "OFF",
        "AUTO"
      ],
      "description": "Whether the bridge imports file-mover object metadata onto its inodes.:\n * `AUTO` - BRIDGE_METADATA_IMPORT_AUTO,\n * `OFF` - BRIDGE_METADATA_IMPORT_OFF"
    }
  }
}

DELETE

Unmounts the bridge from the primary filesystem and deletes it. The cluster restarts its quorum during this call, which briefly interrupts service; the bridge's cached data and metadata are reclaimed in the background afterwards. Local changes not yet exported to the bucket are lost; the bucket itself is never modified.

Parameters

Name Description Required
filesystem_uuid Bridge filesystem UUID Yes

Response

Codes

Code Description
200 Return value on success