List agents for scanner
GET {{baseUrl}}/scanners/:scanner_id/agents?f=deserunt&ft=deserunt&w=deserunt&wf=deserunt&limit=67454373&offset=67454373&sort=deserunt
Returns a list of agents for the specified scanner.
Requires SCAN MANAGER [40] user permissions. See Permissions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
f | string | 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. | |
ft | string | 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. | |
w | string | 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 . | |
wf | string | 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. | |
limit | number | 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 | number | The starting record to retrieve. If this parameter is omitted, Tenable.io uses the default value of 0 . | |
sort | string | 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. |
RESPONSES
status: OK
{"agents":[{"id":157,"uuid":"c6ce4255-b386-4e71-be64-0d06434bac5d","name":"GRD-LPTP","platform":"WINDOWS","distro":"win-x86-64","ip":"172.204.81.57","last_scanned":1515620036,"plugin_feed_id":"201801081515","core_build":"106","core_version":"7.0.0","linked_on":1456775443,"last_connect":1515674073,"status":"off","groups":[{"name":"CodyAgents","id":8},{"name":"Agent Group A","id":3316}]},{"id":14569,"uuid":"bce54c02-392d-4305-bc83-e1e1d8130afd","name":"scr-lce.lab.tenablesecurity.com","platform":"LINUX","distro":"es7-x86-64","ip":"172.204.81.57","plugin_feed_id":"201805161620","core_build":"13","core_version":"7.0.3","linked_on":1508329832,"last_connect":1526565530,"status":"off","groups":[{"name":"SC Research","id":1167}]},{"id":14570,"uuid":"0657efe4-0ba0-423a-ac5f-52a6e23d2e11","name":"scr-sc5.lab.tenablesecurity.com","platform":"LINUX","distro":"es7-x86-64","ip":"172.204.81.57","plugin_feed_id":"201805161620","core_build":"13","core_version":"7.0.3","linked_on":1508329886,"last_connect":1526565624,"status":"off","groups":[{"name":"SC Research","id":1167}]}],"pagination":{"total":3,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}