Search Device
Search for device
URL: /adc-device-search
Type: POST
Parameters
| ParamType | Name | Description | FieldType |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (Eg: web, external) | String |
| Payload | Input | Key value for the search. Possible keys are : "name","ip","vendor","subsystem","version","dataCenter" | Key:Value |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 200 | OK | Matching results found for the given input |
Sample Request/Response
Use Case
Get all the ADC F5 devices.
Request URL
http://appviewxapi.com/avxapi/avxapi/adc-device-search?gwkey=f000ca01&gwsource=external
Request Payload
{
"payload": {
"input": {
"vendor": "F5"
}
}
}
Response
{
"response": {
"devices": [
"name": "192.168.112.93",
"ip": "192.168.112.93",
"fqdn": null,
"deviceType": [
"LTM",
"GTM"
],
"module": [
"LTM",
"BIG-IP DNS"
],
"dataCenter": "",
"vendor": "F5",
"version": "v13",
"detailedVersion": "13.0.0 build 0.0.1645",
"subsystem": "LoadBalancer",
"category": "ADC",
.....
],
"totalRecords": 2,
"obtainedRecords": 1,
"obtainedRecordRange": {
"start": 1,
"end": 1
},
"message": "Matching results found for the given input.",
"appStatusCode": null,
"tags": null,
"headers": null
}