Retrieve the relationship status and configuration for the specified hub portal.
Parameters
Name
Description
Required
id
Portal ID
Yes
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"v1_portal_hub","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","AUTHORIZED","DELETING"],"description":"State of the portal:\n * `AUTHORIZED` - An authorized spoke portal or hub portal that can be used for file system access.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PENDING` - A spoke portal or hub portal awaiting authorization. Hub portals are created in this state.,\n * `UNLINKED` - A newly created spoke portal without a relationship with another cluster."},"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."},"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.
Parameters
Name
Description
Required
id
Portal ID
Yes
force
No
Response
Codes
Code
Description
202
Return value on success
PATCH
Change configuration for the specified hub portal.
Parameters
Name
Description
Required
id
Portal ID
Yes
If-Match
ETag for expected version
No
Request
Schema
{"description":"v1_portal_hub_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","AUTHORIZED","DELETING"],"description":"State of the portal:\n * `AUTHORIZED` - An authorized spoke portal or hub portal that can be used for file system access.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PENDING` - A spoke portal or hub portal awaiting authorization. Hub portals are created in this state.,\n * `UNLINKED` - A newly created spoke portal without a relationship with another cluster."},"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."},"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":"v1_portal_hub","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","AUTHORIZED","DELETING"],"description":"State of the portal:\n * `AUTHORIZED` - An authorized spoke portal or hub portal that can be used for file system access.,\n * `DELETING` - A portal in the process of synchronizing outstanding changes before deletion.,\n * `PENDING` - A spoke portal or hub portal awaiting authorization. Hub portals are created in this state.,\n * `UNLINKED` - A newly created spoke portal without a relationship with another cluster."},"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."},"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"}}}
