Endpoint

/v2/portal/hubs/{id}/roots/{dir}

POST

Authorize the specified hub root directory for the specified hub portal. This allows the spoke portal to access the data in the hub root directory.

Parameters

Name Description Required
id Portal ID Yes
dir Directory ID Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v2_portal_hub",
  "type": "object",
  "properties": {
    "id": {
      "description": "Hub portal ID",
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "PORTAL_READ_ONLY",
        "PORTAL_READ_WRITE"
      ],
      "description": "Type of the portal (read-only or read-write):\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE"
    },
    "state": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "DELETING"
      ],
      "description": "State of the portal:\n * `ACCEPTED` - API_PORTAL_ACCEPTED,\n * `DELETING` - API_PORTAL_DELETING,\n * `PENDING` - API_PORTAL_PENDING"
    },
    "status": {
      "type": "string",
      "enum": [
        "INACTIVE",
        "ACTIVE",
        "DEGRADED"
      ],
      "description": "Status of the portal:\n * `ACTIVE` - PORTAL_ACTIVE,\n * `DEGRADED` - PORTAL_DEGRADED,\n * `INACTIVE` - PORTAL_INACTIVE"
    },
    "spoke_host": {
      "description": "IP address of a node in the remote cluster",
      "type": "object",
      "properties": {
        "address": {
          "description": "address",
          "type": "string"
        },
        "port": {
          "description": "port",
          "type": "number"
        }
      }
    },
    "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"
    },
    "pending_roots": {
      "type": "array",
      "items": {
        "description": "Set of hub root directories that are pending authorization",
        "type": "string"
      }
    },
    "authorized_roots": {
      "type": "array",
      "items": {
        "description": "Set of hub root directories that are authorized for access",
        "type": "string"
      }
    }
  }
}

DELETE

Deny access to the specified hub root directory for the specified hub portal. This action does not affect the data in the hub root directory.

Parameters

Name Description Required
id Portal ID Yes
dir Directory ID Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v2_portal_hub",
  "type": "object",
  "properties": {
    "id": {
      "description": "Hub portal ID",
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "PORTAL_READ_ONLY",
        "PORTAL_READ_WRITE"
      ],
      "description": "Type of the portal (read-only or read-write):\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE"
    },
    "state": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "DELETING"
      ],
      "description": "State of the portal:\n * `ACCEPTED` - API_PORTAL_ACCEPTED,\n * `DELETING` - API_PORTAL_DELETING,\n * `PENDING` - API_PORTAL_PENDING"
    },
    "status": {
      "type": "string",
      "enum": [
        "INACTIVE",
        "ACTIVE",
        "DEGRADED"
      ],
      "description": "Status of the portal:\n * `ACTIVE` - PORTAL_ACTIVE,\n * `DEGRADED` - PORTAL_DEGRADED,\n * `INACTIVE` - PORTAL_INACTIVE"
    },
    "spoke_host": {
      "description": "IP address of a node in the remote cluster",
      "type": "object",
      "properties": {
        "address": {
          "description": "address",
          "type": "string"
        },
        "port": {
          "description": "port",
          "type": "number"
        }
      }
    },
    "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"
    },
    "pending_roots": {
      "type": "array",
      "items": {
        "description": "Set of hub root directories that are pending authorization",
        "type": "string"
      }
    },
    "authorized_roots": {
      "type": "array",
      "items": {
        "description": "Set of hub root directories that are authorized for access",
        "type": "string"
      }
    }
  }
}