Get Hubs
This endpoint retrieves all available hubs associated with a given organisation, providing key details such as the hub’s unique ID, name, serial number, creation and update timestamps, and associated metadata. Each hub includes hardware and connection attributes, specifying configurable properties like connection type, status, speed, firmware version, and bootloader version. Additionally, it contains information on assigned services, communication details, and settings, including synchronisation and charging configurations, port mappings, and manufacturer details. Metadata further outlines the applied values for these properties, offering a structured overview of each hub's capabilities and constraints within the organisation.
To enhance flexibility, this endpoint supports additional parameters to limit the number of results returned, ensuring efficient data handling. A continuation token can also be used to paginate through large datasets, allowing you to retrieve workflows in manageable chunks for improved performance and scalability.
Syntax: see 'CCall Structure
Type = 'GET'
|
'https://connect.cambrionix.com/api/hardware/v1/hubs?token=token&limit=return-number' |
| Variable | Description |
|---|---|
| token | Continuation token |
| return-number | Number of records to return |
Returns:
|
{ "result": [ { "created": { "time": time }, "updated": { "time": time }, "serialNumber": "hub-serial", "host": { "connection": { "status": "connection-status", "updated": time, "type": "connection-type", "version": "usb-version", "speed": { "current": { "description": "usb-description", "value": "usb-speed" } } } }, "firmware": { "version": "firmware-version", "type": "firmware-type" }, "bootloader": { "version": "bootloader-version" }, "name": "hub-name", "settings": {hub-settings }, "product": { "id": "product-id", "name": "hub-name", "description": "hub-description", "family": "hub-family", "ports": port-quantity, "identifiers": ["hub-identifiers"], "firmware": { "type": "firmware-type" }, "manufacturer": { "name": "manufacturer-name", "releaseDate": "hub-release-date" } }, "service": { "id": "service-id", "address": { "hostName": "service-hostname", "port": service-port }, "computer": { "id": "computer-id", "name": "computer-name " } }, "serialPort": { "status": "connection-status", "location": { "computerId": "computer-id", "locationId": location-id }, "connection": "serial-port" }, "id": "hub-serial", "organization": { "id": "organisation-id", "name": "organisation-name", "owner": { "id": "user-id" } } } ], "_metadata": { "total": total-entries } |
| Output | Description |
|---|---|
| time | The hub time, shown as an integer in ms |
| hub-serial | This is the serial number of the hub |
| connection-status | The connection status i.e. connected |
| connection-type | The type connection i.e. USB |
| usb-version | The USB version number of the connection to the hub |
| usb-description | Name of USB connection i.e. SuperSpeed USB 5Gbps |
| usb-speed | Maximum speed USB connection capable of |
| firmware-version | Version number of the firmware. Format 'N.nn' |
| firmware-type | Used to denote which firmware the product accepts |
| bootloader-version | Version number of the bootloader. Format 'N.nn' |
| hub-name | Name of the hub |
| hub-settings | The hub internal settings |
| product-id | This is the id of the hardware |
| hub-description | This is the description of the product |
| hub-family | This is the hardware family i.e. Thundersync |
| port-quantity | This is the number of ports on the hub |
| hub-identifiers | These are identifiers of the hub, hub-name and description |
| manufacturer-name | This is the name of the manufacturer |
| hub-release-date | This is the release date of the hub |
| service-id | This is the id of the service as a unique 128-bit number |
| service-hostname | This is the hostname of the service |
| service-port | This is the port the service is using |
| computer-id | This is the id of the computer as a unique 128-bit number |
| computer-name | The name of the computer |
| location-id | This is the id of the location as a unique 128-bit number |
| serial-port | The Serial port the product is connected to. |
| organisation-id | This is the id of the organisation as a unique 128-bit number |
| organisation-name | This is the name of the organisation |
| user-id | This is the id of the user as a unique 128-bit number |
| total-entries | This is the total amount of entries returned |
Example
curl -X 'GET' \
'https://connect.cambrionix.com/api/hardware/v1/hubs?limit=1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOUMb4mIAA'Returns
This response has been truncated for clarity within the manual.
{
"result": [
{
"created": {
"time": 1739188916889
},
"updated": {
"time": 1739880857663
},
"serialNumber": "0000006567CDF436",
"host": {
"connection": {
"status": "connected",
"updated": 1739553771614,
"type": "usb",
"version": "3.2",
"speed": {
"current": {
"description": "SuperSpeed USB 5Gbps",
"value": "5Gbps"
}
}
}
},
"firmware": {
"version": "1.89.4",
"type": "un"
},
"bootloader": {
"version": "0.20.0"
},
"name": "SuperSync15",
"settings": {
"alt_sync_chrg": "1 1 1 1 1 1 1 1 1 1 1 1 1 1 1",
"attach_threshold": "d",
"charged_threshold": "d",
"company_name": "cambrionix",
"default_profile": "0 0 0 0 0 0 0 0 0 0 0 0 0 0 0",
"display_mode": "d",
"local_name": "-",
"misc_flags": "0008",
"ports_on": "1 1 1 1 1 1 1 1 1 1 1 1 1 1 1",
"product_name": "SuperSync15",
"remap_ports": "1 2 3 4 5 6 7 8 9 10 11 12 13 14 15",
"stagger": "d",
"stagger_offset": "d",
"sync_chrg": "1 1 1 1 1 1 1 1 1 1 1 1 1 1 1",
"temperature_max": "d"
},
"product": {
"id": "00000000-0000-0000-0000-000000000001",
"name": "SuperSync15",
"description": "SuperSync15",
"family": "SuperSync",
"ports": 15,
"identifiers": [
"SuperSync15",
"SS15"
],
"firmware": {
"type": "un"
},
"manufacturer": {
"name": "Cambrionix",
"releaseDate": "2019-01-01"
}
},
"service": {
"id": "0b27f13f-e16f-5667-a137-9e3eff423532",
"address": {
"hostName": "cbrxci-007.api.cambrionix.com",
"port": 43424
},
"computer": {
"id": "9a607176-43eb-4ba6-9d6b-b02c13d21d28",
"name": "CBRXCI-007 "
}
},
"serialPort": {
"status": "connected",
"location": {
"computerId": "9a607176-43eb-4ba6-9d6b-b02c13d21d28",
"locationId": 1782727680
},
"connection": "COM8"
},
"id": "0000006567CDF436",
"organization": {
"id": "dafc70d5-a4c8-42a3-ad8d-a8ccb5fa313f",
"name": "Staging Test Platform ( Premium License ) ",
"owner": {
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460"
}
}
}
],
"_metadata": {
"total": 212
}
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned