Endpoint

/v2/portal/hubs/

GET

List the relationship status and configuration for all hub portals on the current cluster.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v2_portal_hubs",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of hub portals",
        "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` - A portal that is in an active relationship.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PENDING` - A portal not yet in an active relationship."
          },
          "status": {
            "type": "string",
            "enum": [
              "INACTIVE",
              "ACTIVE",
              "DEGRADED"
            ],
            "description": "Status of the portal:\n * `ACTIVE` - A fully connected portal ready for use.,\n * `DEGRADED` - A portal missing one or more connections with the other cluster in the relationship.,\n * `INACTIVE` - A portal that is not ready for use."
          },
          "spoke_hosts": {
            "type": "array",
            "items": {
              "description": "IP addresses and TCP ports of nodes 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"
            }
          }
        }
      }
    }
  }
}