Rest API Config endpoint for netflow collectors (NetAudit module users only)
Object type: netflow_collector
Request URL: /rest/config/netflow_collector
Example GET
{
"list" : [
{
"id" : "1",
"monitoring_server" : {
"name" : "Master Monitoring Server",
"ref" : "/rest/config/monitoringcluster/1"
},
"name" : "Master server collector",
"port": "9995",
"ref" : "/rest/config/netflowcollector/1",
"sport": "6343",
"uncommitted" : "0"
},
{
"id" : "2",
"monitoring_server" : {
"name" : "Boston Datacentre",
"ref" : "/rest/config/monitoringcluster/2"
},
"name" : "Boston collector",
"port": "9995",
"ref" : "/rest/config/netflowcollector/2",
"sport": "6343",
"uncommitted" : "0"
}
],
"summary" : {
"allrows" : "2",
"page" : "1",
"rows" : "2",
"totalpages" : "1",
"totalrows" : "2"
}
}
Example GET single
Request URL: /rest/config/netflow_collector/1
Response:
{
"object" : {
"id" : "1",
"monitoring_server" : {
"name" : "Master Monitoring Server",
"ref" : "/rest/config/monitoringcluster/1"
},
"port": "9995",
"name" : "Master server collector",
"sport": "6343",
"uncommitted" : "0"
}
}
Example PUT
Note: Only the name can be updated for an existing collector.
Request URL: /rest/config/netflow_collector/1
Request data:
{
"id" : "1",
"monitoringserver_id" : "1", // Ignored
"name" : "A new name",
"port": "9995",
"sport": "6343",
}
Response:
{
"object" : {
"id" : "1",
"monitoring_server" : {
"name" : "Master Monitoring Server",
"ref" : "/rest/config/monitoringcluster/1"
},
"port": "9995",
"name" : "A new name",
"sport": "6343",
"uncommitted" : "1"
}
}
Example POST
Request URL: /rest/config/netflow_collector
Request data:
{
"monitoringserver_id" : "2",
"name" : "Second collector",
}
Response:
{
"object" : {
"id" : "3",
"monitoring_server" : {
"name" : "Boston Datacentre",
"ref" : "/rest/config/monitoringcluster/2"
},
"port": "9995",
"name" : "Second collector",
"sport": "6343",
"uncommitted" : "1"
}
}
Example DELETE
Request URL: /rest/config/netflow_collector/2
Response:
{
"success" : "1"
}