API to Get List of Appliances
This endpoint returns the list of Appliances.
GET /openapi/v1/ext_appliances?root_scope_id=<root_scope_id>&type=<type>
where <root_scope_id> is the root_scope_id that can be obtained from the Get scopes API, <type> is a string to decide Appliance type.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
root_scope_id |
string |
Specify the root scope |
| type |
string |
Specify the Appliance type, the value can be either “TETRATION_EDGE”, “TETRATION_DATA_INGEST”, “TETRATION_EXPORT”, “TETRATION_ERSPAN” or “TETRATION_INTERNAL” |
Response object: Returns the list of Appliance.
Sample response
resp = restclient.get('/ext_appliances?root_scope_id=63bf8d2f497d4f7287dbd335&type=TETRATION_INTERNAL')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
[
{
"root_scope_id": "63bf8d2f497d4f7287dbd335",
"type": "tetration_internal",
"status": {
"state": "active",
"controller_state": "up",
"message": "",
"display_state": "active"
},
"auto_upgrade": true,
"created_at": 1673498141,
"updated_at": 1673498141,
"registered_at": 1673498141,
"last_checkin_at": 0,
"last_rpm_sent_at": 0,
"upgrade_attempts": 0,
"delete_attempts": 0,
"last_delete_msg_sent_at": 0,
"taas": false,
"deleted": false,
"deleted_at": 0,
"connector_limit": 5000,
"available_slots": 5000,
"internal": true,
"id": "63bf8e1d6419d06bef39bc85",
"ha_peer_appliance_id": "",
"display_type": "Tetration Internal"
}
]