portal/hubs/

{
  "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",
              "PORTAL_PAUSED",
              "PORTAL_SUSPENDED"
            ],
            "description": "Type of the portal (read-only or read-write):\n * `PORTAL_PAUSED` - PORTAL_PAUSED,\n * `PORTAL_READ_ONLY` - PORTAL_READ_ONLY,\n * `PORTAL_READ_WRITE` - PORTAL_READ_WRITE,\n * `PORTAL_SUSPENDED` - PORTAL_SUSPENDED"
          },
          "state": {
            "type": "string",
            "enum": [
              "PENDING",
              "ACCEPTED",
              "QUIESCING",
              "PAUSING",
              "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 * `PAUSING` - A portal closing spoke client state and synchronizing outstanding changes before it becomes paused.,\n * `PENDING` - A portal not yet in an active relationship.,\n * `QUIESCING` - A portal synchronizing outstanding changes before it becomes read-only."
          },
          "status": {
            "type": "string",
            "enum": [
              "INACTIVE",
              "ACTIVE",
              "DEGRADED",
              "DISCONNECTED"
            ],
            "description": "Status of the portal:\n * `ACTIVE` - A fully connected portal ready for use.,\n * `DEGRADED` - A portal whose quorum is missing a cluster other than this relationship's peer.,\n * `DISCONNECTED` - A portal whose quorum is missing this relationship's own peer.,\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"
          },
          "filesystem_uuid": {
            "description": "UUID of the filesystem shared 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"
            }
          }
        }
      }
    }
  }
}