External DocumentationTo learn more, visit the Tenable documentation.
Parameters
| Parameter | Description |
|---|---|
| Filter | Apply a filter in the format ::. For example, field1:match:sometext would match any records where the value of field1 contains sometext. You can use multiple query filters. For a list of supported filters, use the GET /filters/scans/agents endpoint. |
| Filter Type | Filter type. If the filter type is and, the record is only returned if all filters match. If the filter type is or, the record is returned if any of the filters match. |
| Limit | The number of records to retrieve. If this parameter is omitted, Tenable.io uses the default value of 50. The minimum supported limit is 1, and the maximum supported limit is 5000. |
| Offset | The starting record to retrieve. If this parameter is omitted, Tenable.io uses the default value of 0. |
| Scanner ID | The ID of the scanner to query for agents. |
| Sort | The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc). For example, name:desc would sort results by the name field in descending order.If you specify multiple fields, the fields must be separated by commas. For example, name:desc,platform:asc would first sort results by the name field in descending order and then by the platform field in ascending order.Sort can only be applied to the sortable_fields specified by the filter capabilities. There may be no more than max_sort_fields number of columns used in the sort, as specified by the filter capabilities. |
| Wildcard Filter | Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard_fields’ values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if w=wild&f=field1:match:one&f=field2:match:two&ft=or, the record would match if the value of any supported wildcard_fields contained wild, AND either field1’s value contained one or field2’s value contained two. |
| Wildcard Filter Fields | A comma-delimited subset of wildcard_fields to search when applying the wildcard filter. For example, field1,field2. If w is provided, but wf is not, then all wildcard_fields’ values are searched against the wildcard filter text. |
Example Output
{
"value": {
"agents": [
{
"core_build": "106",
"core_version": "7.0.0",
"distro": "win-x86-64",
"groups": [
{
"id": 8,
"name": "CodyAgents"
},
{
"id": 3316,
"name": "Agent Group A"
}
],
"id": 157,
"ip": "192.0.2.57",
"last_connect": 1515674073,
"last_scanned": 1515620036,
"linked_on": 1456775443,
"name": "GRD-LPTP",
"platform": "WINDOWS",
"plugin_feed_id": "201801081515",
"status": "off",
"uuid": "655993d5-c131-46e8-a82f-957f6f894cac"
},
{
"core_build": "13",
"core_version": "7.0.3",
"distro": "es7-x86-64",
"groups": [
{
"id": 1167,
"name": "SC Research"
}
],
"id": 14569,
"ip": "192.0.2.57",
"last_connect": 1526565530,
"linked_on": 1508329832,
"name": "example.com",
"platform": "LINUX",
"plugin_feed_id": "201805161620",
"status": "off",
"uuid": "72ac6ad1-fc86-4af4-be0c-0ff3bfbfb242"
},
{
"core_build": "13",
"core_version": "7.0.3",
"distro": "es7-x86-64",
"groups": [
{
"id": 1167,
"name": "SC Research"
}
],
"id": 14570,
"ip": "192.0.2.57",
"last_connect": 1526565624,
"linked_on": 1508329886,
"name": "example.com",
"platform": "LINUX",
"plugin_feed_id": "201805161620",
"status": "off",
"uuid": "938cb466-06ea-477e-abb0-99d8da0e0f20"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"sort": [
{
"name": "name",
"order": "asc"
}
],
"total": 3
}
}
}