Delete Virtual Hub
This endpoint allows for the deletion of a specific virtual hub within an organisation using its unique hub ID. Removing a virtual hub will delete its associated attributes, including its unique identifier, name, description, creation and update timestamps, and organisational association. Additionally, the deletion process will remove the virtual hub’s connected port mappings, unlinking it from any associated physical hubs and ports. This ensures that the virtual hub is fully removed from the system while maintaining the integrity of other network configurations. By enabling the removal of virtual hubs, organisations can efficiently manage and optimise their hub infrastructure.
Syntax: see 'CCall Structure
Type = 'DELETE'
'https://connect.cambrionix.com/api/hardware/v1/virtual-hubs/virtual-hub-id' |
Variable | Description |
---|---|
virtual-hub-id | This is the id of the virtual hub as a unique 128-bit number |
Returns:
{ "result": {} } |
Example
curl -X 'DELETE' \
'https://connect.cambrionix.com/api/hardware/v1/virtual-hubs/00f7543a-d6ef-4059-8691-9ce54a9f12e1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI5l2QdQQA'
Returns
{
"result": {}
}
Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned