List agents for agent group
GET {{baseUrl}}/scanners/:scanner_id/agent-groups/:agent_group_id/agents?f=deserunt&ft=deserunt&w=deserunt&wf=deserunt&limit=67454373&offset=67454373&sort=deserunt
Returns a list of agents for the specified agent group.
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":20,"uuid":"07e496f5-d2dc-4232-9733-12e5f7d05ae3","name":"Codys-MacBook-Pro.local","platform":"DARWIN","distro":"macosx","ip":"10.31.100.110","last_scanned":1545272687,"plugin_feed_id":"201812281741","core_build":"1","core_version":"7.2.1","linked_on":1452106253,"last_connect":1546264939,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group B","id":31},{"name":"Agent Group C","id":3315}],"supports_remote_logs":false},{"id":65,"uuid":"22f00428-3095-d55f-e620-aa7392c862757b06b5e32a5e47a1","name":"DC02","platform":"WINDOWS","distro":"win-x86-64","ip":"10.31.114.10","last_scanned":1478743235,"plugin_feed_id":"0","linked_on":1453821446,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group B","id":31},{"name":"Agent Group C","id":3316}],"supports_remote_logs":false},{"id":643,"uuid":"84b8e813-fad6-d1a5-e9f6-ac641d3b0b012596d192e3cf57f8","name":"DESKTOP-PSNDJQ6","platform":"WINDOWS","distro":"win-x86-64","ip":"172.16.0.3","last_scanned":1477011651,"plugin_feed_id":"0","linked_on":1468619962,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group C","id":3316}],"supports_remote_logs":false}],"pagination":{"total":3,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}