This URL allows you to get details of the Suricata Sensor
Resource URL
domain/device/<sensor_name>?deviceType=ips
Request Parameters
URL parameters:
Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| Name of the Sensor | String | Yes |
Response Parameters
Following fields are returned if the request parameters are correct.
Field Name | Description | Data Type |
|---|---|---|
| Displays the success status | Boolean |
| Displays the message | String |
| Displays the error message | Boolean |
| An object that contains the details of the field | Object |
| Error code | Number |
Details of data:
Field Name | Description | Data Type |
|---|---|---|
| An array that contains the details of the field | Array |
Example
Request
GET https://<IPSM_IP>/sdkapi/domain/device/suricata-82?deviceType=ips
Response
{
"success": true,
"msg": "Device details retrieved successfully.",
"errMsg": null,
"data": {
"results": [
{
"dmDataMap": {
"DeviceDetails": {
"fromDB": true,
"supported": true,
"cluster": null,
"deviceName": "suricata-82",
"deviceType": "Suricata Sensor",
"model": "IPS-NS9600",
"serialNumber": "P396000001",
"swVersion": "11.1.240.142",
"lastUpgrade": 0,
"systemVO": {
"licenseVO": {
"activeModeInDevice": 3,
"licensePresent": true,
"licenseInvalidReason": null,
"turboModeSupported": true,
"currMode": 3,
"capacity": 60.0,
"units": "Gbps",
"gracePeriodActive": false
}
},
"stackVO": null,
"clusterVO": null,
"mgmtIpAddress": "10.213.172.82/255.255.255.0",
"lastReboot": 1770654470478,
"ownerDomain": "/My Company",
"comment": "",
"haName": null,
"hardwareVersion": "0.50",
"vNSPCluster": null,
"vNSPProbe": null,
"cloudInstanceId": null,
"defaultGateway": "10.213.172.252",
"fipsMode": 0,
"connectionStatus": "FULLY_CONNECTED",
"channelStatus": {
"commandChannel": 1,
"alertChannel": 1,
"packetChannel": 1
},
"deviceId": 1063,
"rebootStatus": "NO_REBOOT_REQUIRED",
"rebootReason": null,
"contact": null,
"location": null,
"upgradeDetails": null,
"vNSPClusterId": 0,
"deviceHAId": 0,
"primarySensorId": 0,
"vidsId": 178,
"vidsForLink": null,
"createdDomainId": 0,
"managerName": null,
"featureName": "DeviceDetails",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
"DeploymentDetails": {
"fromDB": false,
"supported": true,
"cluster": null,
"pendingChanges": "None",
"lastDeployment": 1771009366000,
"deploymentMode": "Direct",
"deploymentStatus": "SYNCHRONIZED",
"deploymentStatusDetails": null,
"offlineSigFileName": null,
"bulkDeployReason": "",
"lastSuricataConfigDeployment": 1771010790000,
"suricataConfigDeploymentStatus": "SYNCHRONIZED",
"suricataConfigDeploymentStatusDetails": null,
"featureName": "DeploymentDetails",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
"Protections": {
"fromDB": false,
"supported": true,
"cluster": null,
"sigsetVersion": "11.10.33.7",
"botVersion": "hide",
"avVersion": "hide",
"gamVersion": "hide",
"gamDatVersion": "hide",
"avDatVersion": "hide",
"latestSigsetVersion": "11.10.33.7",
"latestBotVersion": "hide",
"latestAvVersion": "hide",
"latestGamVersion": "hide",
"latestGamDatVersion": "hide",
"latestAvDatVersion": "hide",
"rulesetVersion": "16.1109",
"rulesetPresent": true,
"featureName": "Protections",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
"DeviceFaults": {
"fromDB": false,
"supported": true,
"cluster": null,
"totalFaults": 0,
"criticalFaults": 0,
"errorFaults": 0,
"warningFaults": 0,
"infoFaults": 0,
"featureName": "DeviceFaults",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
"DeviceHealth": {
"fromDB": false,
"supported": true,
"cluster": null,
"inspection": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"performance": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"hardware": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"faults": null,
"powerSupply": {
"powerSupplyA": "NONOPERATIONAL",
"powerSupplyB": "OPERATIONAL",
"secPowerSupplyA": null,
"secPowerSupplyB": null
},
"layer2reason": null,
"overallHealth": {
"status": "ABNORMAL",
"severity": "HIGH",
"link": null,
"faultCount": null
},
"internalHealth": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"physicalPortHealth": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"featureName": "DeviceHealth",
"ha": false,
"dataState": "LOADED",
"stackMember": false
}
},
"dmDataList": [
{
"fromDB": true,
"supported": true,
"cluster": null,
"deviceName": "suricata-82",
"deviceType": "Suricata Sensor",
"model": "IPS-NS9600",
"serialNumber": "P396000001",
"swVersion": "11.1.240.142",
"lastUpgrade": 0,
"systemVO": {
"licenseVO": {
"activeModeInDevice": 3,
"licensePresent": true,
"licenseInvalidReason": null,
"turboModeSupported": true,
"currMode": 3,
"capacity": 60.0,
"units": "Gbps",
"gracePeriodActive": false
}
},
"stackVO": null,
"clusterVO": null,
"mgmtIpAddress": "10.213.172.82/255.255.255.0",
"lastReboot": 1770654470478,
"ownerDomain": "/My Company",
"comment": "",
"haName": null,
"hardwareVersion": "0.50",
"vNSPCluster": null,
"vNSPProbe": null,
"cloudInstanceId": null,
"defaultGateway": "10.213.172.252",
"fipsMode": 0,
"connectionStatus": "FULLY_CONNECTED",
"channelStatus": {
"commandChannel": 1,
"alertChannel": 1,
"packetChannel": 1
},
"deviceId": 1063,
"rebootStatus": "NO_REBOOT_REQUIRED",
"rebootReason": null,
"contact": null,
"location": null,
"upgradeDetails": null,
"vNSPClusterId": 0,
"deviceHAId": 0,
"primarySensorId": 0,
"vidsId": 178,
"vidsForLink": null,
"createdDomainId": 0,
"managerName": null,
"featureName": "DeviceDetails",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
{
"fromDB": false,
"supported": true,
"cluster": null,
"pendingChanges": "None",
"lastDeployment": 1771009366000,
"deploymentMode": "Direct",
"deploymentStatus": "SYNCHRONIZED",
"deploymentStatusDetails": null,
"offlineSigFileName": null,
"bulkDeployReason": "",
"lastSuricataConfigDeployment": 1771010790000,
"suricataConfigDeploymentStatus": "SYNCHRONIZED",
"suricataConfigDeploymentStatusDetails": null,
"featureName": "DeploymentDetails",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
{
"fromDB": false,
"supported": true,
"cluster": null,
"sigsetVersion": "11.10.33.7",
"botVersion": "hide",
"avVersion": "hide",
"gamVersion": "hide",
"gamDatVersion": "hide",
"avDatVersion": "hide",
"latestSigsetVersion": "11.10.33.7",
"latestBotVersion": "hide",
"latestAvVersion": "hide",
"latestGamVersion": "hide",
"latestGamDatVersion": "hide",
"latestAvDatVersion": "hide",
"rulesetVersion": "16.1109",
"rulesetPresent": true,
"featureName": "Protections",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
{
"fromDB": false,
"supported": true,
"cluster": null,
"totalFaults": 0,
"criticalFaults": 0,
"errorFaults": 0,
"warningFaults": 0,
"infoFaults": 0,
"featureName": "DeviceFaults",
"ha": false,
"dataState": "LOADED",
"stackMember": false
},
{
"fromDB": false,
"supported": true,
"cluster": null,
"inspection": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"performance": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"hardware": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"faults": null,
"powerSupply": {
"powerSupplyA": "NONOPERATIONAL",
"powerSupplyB": "OPERATIONAL",
"secPowerSupplyA": null,
"secPowerSupplyB": null
},
"layer2reason": null,
"overallHealth": {
"status": "ABNORMAL",
"severity": "HIGH",
"link": null,
"faultCount": null
},
"internalHealth": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"physicalPortHealth": {
"status": "NORMAL",
"severity": "LOW",
"link": null,
"faultCount": null
},
"featureName": "DeviceHealth",
"ha": false,
"dataState": "LOADED",
"stackMember": false
}
]
}
]
},
"errorCode": 0
}
Error Information
The following error code is returned by this URL:
S.No | Generic Error Codes | ErrorMessage | Error Reason |
|---|---|---|---|
1 | 1001 | Bad URL - HTTP 404 Not Found | Mistyped URL |
Internal Error – Null | Incorrect Input data, authentication issues |