/v1/portal/hubs/{id} | Qumulo Documentation

Endpoint

/v1/portal/hubs/{id}

GET

Retrieve the relationship status and configuration for the specified hub portal.

Parameters

Name	Description	Required
`id`	Portal ID	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_portal_hub_relationship",
  "type": "object",
  "properties": {
    "id": {
      "description": "Hub portal ID",
      "type": "number"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "UNLINKED",
        "PENDING",
        "ACTIVE",
        "ENDED"
      ],
      "description": "State of the portal:\n * `ACTIVE` - PORTAL_ACTIVE,\n * `ENDED` - PORTAL_ENDED,\n * `PENDING` - PORTAL_PENDING,\n * `UNLINKED` - PORTAL_UNLINKED"
    },
    "spoke_cluster_uuid": {
      "description": "UUID of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_cluster_name": {
      "description": "Name of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_address": {
      "description": "IP address of a node in the cluster with the spoke portal (if in a relationship)",
      "type": "string"
    },
    "spoke_port": {
      "description": "TCP port for the cluster with the spoke portal (if in a relationship)",
      "type": "number"
    },
    "spoke_type": {
      "type": "string",
      "enum": [
        "SPOKE_READ_ONLY",
        "SPOKE_READ_WRITE"
      ],
      "description": "Type of the spoke portal:\n * `SPOKE_READ_ONLY` - SPOKE_READ_ONLY,\n * `SPOKE_READ_WRITE` - SPOKE_READ_WRITE"
    }
  }
}

DELETE

Delete the specified hub portal from the current cluster.

Parameters

Name	Description	Required
`id`	Portal ID	Yes

Response

Codes

Code	Description
200	Return value on success

PATCH

Change configuration for the specified hub portal.

Parameters

Name	Description	Required
`id`	Portal ID	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_portal_hub_relationship_patch",
  "type": "object",
  "properties": {
    "id": {
      "description": "Hub portal ID",
      "type": "number"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "UNLINKED",
        "PENDING",
        "ACTIVE",
        "ENDED"
      ],
      "description": "State of the portal:\n * `ACTIVE` - PORTAL_ACTIVE,\n * `ENDED` - PORTAL_ENDED,\n * `PENDING` - PORTAL_PENDING,\n * `UNLINKED` - PORTAL_UNLINKED"
    },
    "spoke_cluster_uuid": {
      "description": "UUID of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_cluster_name": {
      "description": "Name of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_address": {
      "description": "IP address of a node in the cluster with the spoke portal (if in a relationship)",
      "type": "string"
    },
    "spoke_port": {
      "description": "TCP port for the cluster with the spoke portal (if in a relationship)",
      "type": "number"
    },
    "spoke_type": {
      "type": "string",
      "enum": [
        "SPOKE_READ_ONLY",
        "SPOKE_READ_WRITE"
      ],
      "description": "Type of the spoke portal:\n * `SPOKE_READ_ONLY` - SPOKE_READ_ONLY,\n * `SPOKE_READ_WRITE` - SPOKE_READ_WRITE"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_portal_hub_relationship",
  "type": "object",
  "properties": {
    "id": {
      "description": "Hub portal ID",
      "type": "number"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "UNLINKED",
        "PENDING",
        "ACTIVE",
        "ENDED"
      ],
      "description": "State of the portal:\n * `ACTIVE` - PORTAL_ACTIVE,\n * `ENDED` - PORTAL_ENDED,\n * `PENDING` - PORTAL_PENDING,\n * `UNLINKED` - PORTAL_UNLINKED"
    },
    "spoke_cluster_uuid": {
      "description": "UUID of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_cluster_name": {
      "description": "Name of the cluster with the spoke portal",
      "type": "string"
    },
    "spoke_address": {
      "description": "IP address of a node in the cluster with the spoke portal (if in a relationship)",
      "type": "string"
    },
    "spoke_port": {
      "description": "TCP port for the cluster with the spoke portal (if in a relationship)",
      "type": "number"
    },
    "spoke_type": {
      "type": "string",
      "enum": [
        "SPOKE_READ_ONLY",
        "SPOKE_READ_WRITE"
      ],
      "description": "Type of the spoke portal:\n * `SPOKE_READ_ONLY` - SPOKE_READ_ONLY,\n * `SPOKE_READ_WRITE` - SPOKE_READ_WRITE"
    }
  }
}