Endpoint

/v1/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": "api_portal_hub_relationships",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of hub portals",
        "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"
          }
        }
      }
    }
  }
}