These endpoints may only be used by administrators. |
/sensor-proxy
GET MethodsGets the list of Sensor Proxies. NOTE:This call will return all Sensor Proxies for an Administrator. Fields ParameterThe fields parameter should be specified along the query string, and it takes the syntax ?fields=<field>,... Allowed Fields (Admin User) *id **uuid **status platform distro Legend * = always comes back ** = comes back if fields list not specified on GET all Request Query ParametersNone Example Response{
"type": "regular",
"response": [
{
"name": "Sensor Proxy Two",
"status": "2",
"version": "1.0.10",
"platform": "linux",
"distro": "Oracle Linux Server 8.8",
"proxy_build": "2024.1021.51949.11",
"linkedOn": "1231654654",
"modifiedTime": "1231654685",
"id": "2",
"uuid": "xxxxxxxx-xxxx-xxxx-873c-c6b15e2cf0c3"
},
{
"name": "Sidecar 3",
"status": "2",
"version": "1.0.10",
"platform": "linux",
"distro": "Oracle Linux Server 8.8",
"proxy_build": "2024.1021.51949.11",
"linkedOn": "1729708556",
"modifiedTime": "1730304651",
"id": "5",
"uuid": "xxxxxx-916b-11ef-8db5-02420a050005"
}
],
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1727369687
}
|
/sensor-proxy/search
POSTMethodsGets the list of specified Sensor Proxies. Fields ParameterThe fields parameter should be specified along the query string, and it takes the syntax ?fields=<field>,... The limit parameter should be an integer greater than 0 ?limit=<number>,... The startOffset parameter should be an integer greater than 0 ?startOffset=<number>,... The endOffset parameter should be an integer greater than 0 ?endOffset=<number>,... The pagination parameter should a boolean ?pagination=<boolean>,... Allowed Fields *id **uuid **status platform distro Legend * = always comes back ** = comes back if fields list not specified on GET all {
"filters": {
"and": [
{
"property": "linkedOn",
"operator": "between",
"value": "all"
},
{
"property": "modifiedTime",
"operator": "between",
"value": "all"
}
]
}
}
Example Response{
"type": "regular",
"response": {
"totalRecords": "3",
"returnedRecords": 3,
"startOffset": "0",
"results": [
{
"name": "Sensor Proxy Two",
"status": "2",
"version": "1.0.10",
"platform": "linux",
"distro": "Oracle Linux Server 8.8",
"proxy_build": "2024.1021.51949.11",
"linkedOn": "1231654654",
"modifiedTime": "1231654685",
"id": "2",
"uuid": "xxxxxxxx-8a53-416d-873c-c6b15e2cf0c3"
},
{
"name": "Sidecar3",
"status": "2",
"version": "1.0.10",
"platform": "linux",
"distro": "Oracle Linux Server 8.8",
"proxy_build": "2024.1021.51949.11",
"linkedOn": "1729708556",
"modifiedTime": "1730304651",
"id": "5",
"uuid": "xxxxxxxxx-916b-11ef-8db5-02420a050005"
},
{
"name": "Sensor Proxy One",
"status": "2",
"version": "2.1.1",
"platform": "platform1",
"distro": "distro 1",
"proxy_build": "build 1",
"linkedOn": "1231654654",
"modifiedTime": "1231654655",
"id": "1",
"uuid": "aaaa-bbbb-cccc-dddd"
}
]
},
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1730474777
}
|
/sensor-proxy/{id}
GETMethodsGets the Sensor Proxy associated with {id}. NOTE: This call will return Sensor Proxy associated with {id} for an Administrator. Fields ParameterThe fields parameter should be specified along the query string, and it takes the syntax ?fields=<field>,... Allowed Fields (Admin User) *id **uuid **status platform distro Legend
** = comes back if fields list not specified on GET all Request Query ParametersNone Example Response{
"type": "regular",
"response": {
"name": "Sensor Proxy Two",
"status": "2",
"version": "1.0.10",
"platform": "linux",
"distro": "Oracle Linux Server 8.8",
"proxy_build": "2024.1021.51949.11",
"linkedOn": "1231654654",
"modifiedTime": "1231654685",
"id": "2",
"uuid": "xxxxxxxx-xxxx-xxxx-873c-c6b15e2cf0c3"
},
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1727369700
}
PATCH Edits the Sensor Proxy associated with {id}, changing only the passed in fields. Request Parameters{
"name": "Sensor Proxy update",
"description": "description update",
"enabled": "true" // false
}
Example ResponseDELETE Deletes the Sensor Proxy associated with {id}. Request ParametersNone Example Response{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1402436001
}
|
|---|
