/v1/portal/spokes/
List the relationship status and configuration for all spoke portals on the current cluster.
This resource has no parameters.
Codes
Code
Description
200
Return value on success
Schema
{
"description" : "api_portal_spoke_relationships" ,
"type" : "object" ,
"properties" : {
"entries" : {
"type" : "array" ,
"items" : {
"description" : "List of spoke portals" ,
"type" : "object" ,
"properties" : {
"id" : {
"description" : "Spoke portal ID" ,
"type" : "number"
},
"spoke_root" : {
"description" : "Local spoke portal root directory file ID" ,
"type" : "string"
},
"spoke_root_path" : {
"description" : "Local spoke portal root directory path" ,
"type" : "string"
},
"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"
},
"hub_root" : {
"description" : "Remote hub portal root directory (if in a relationship)" ,
"type" : "string"
},
"hub_address" : {
"description" : "IP address of a node in the cluster with the hub portal (if in a relationship)" ,
"type" : "string"
},
"hub_port" : {
"description" : "TCP port for the cluster with the hub portal (if in a relationship)" ,
"type" : "number"
},
"hub_id" : {
"description" : "Corresponding remote hub portal id (if in a relationship)" ,
"type" : "number"
}
}
}
}
}
}
Create a spoke portal in the UNLINKED state in the current cluster. It is now possible to propose a relationship between this spoke portal and a hub portal on another cluster.
This resource has no parameters.
Schema
{
"description" : "api_portal_create_request" ,
"type" : "object" ,
"properties" : {
"spoke_root" : {
"description" : "Full path to the spoke portal root directory" ,
"type" : "string"
},
"is_writable_spoke" : {
"description" : "Whether the spoke portal is writable. Default to false. In-development feature." ,
"type" : "boolean"
}
}
}
Codes
Code
Description
200
Return value on success
Schema
{
"type" : "number"
}