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

Endpoint

/v1/portal/hubs/{id}

GET

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

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	Remote Cluster 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"
    },
    "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"
    },
    "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"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "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"
    }
  }
}

DELETE

Delete the specified hub portal from the current cluster.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	Remote Cluster ID	Yes

Response

Codes

Code	Description
200	Return value on success

PATCH

Change configuration for the specified hub portal.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	Remote Cluster 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"
    },
    "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"
    },
    "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"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "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"
    }
  }
}

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"
    },
    "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"
    },
    "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"
    },
    "root": {
      "description": "Local hub portal root directory file ID",
      "type": "string"
    },
    "root_path": {
      "description": "Local hub portal root directory path",
      "type": "string"
    },
    "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"
    }
  }
}