List tag values
GET {{baseUrl}}/tags/values?f=deserunt&ft=deserunt&wf=deserunt&w=deserunt&limit=67454373&offset=67454373&sort=deserunt
Returns a list of tag values. Note: The list can also include the tag categories that do not have any associated values.
Requires BASIC [16] user permissions. See Permissions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
f | string | A filter condition in the field:operator:value format, for example, f=value:match:rhel . Filters should match field:op:value format. Filter conditions can include: |
- value:eq:<value>
- value:match:<value>
- category_name:match:<partial_value>
- category_name:eq:<category_name>
- category_name:match:<partial_category_name>
- description:eq:<description>
- description:match:<partial_description>
- updated_at:date-eq:<timestamp_as_int>
- updated_at:date-gt:<timestamp_as_int>
- updated_at:date-lt:<timestamp_as_int>
- updated_by:eq:<user_uuid> |
|
ft
| string | | If multiplef
parameters are present, specifies whether Tenable.io appliesAND
orOR
to conditions. Supported values areand
andor
. If you omit this parameter when using multiplef
parameters, Tenable.io appliesAND
by default. | |wf
| string | | A comma-separated list of fields to include in the wildcard search. Provides the same functionality as amatch
condition in thef
in parameter. For example,f=value:match:Chi
returns the same results aswf=value&w=Chi
. Wildcard fields include: - category_name
- value
- description
Use thew
parameter to specify the search value. | |w
| string | | A single search value for the wildcard fields specified in thewf
parameter. | |limit
| number | | The number of records to retrieve. If this parameter is omitted, Tenable.io uses the default value of5000
. | |offset
| number | | The starting record to retrieve. If this parameter is omitted, Tenable.io uses the default value of0
. | |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
ordesc
). For example,value:desc
would sort results by thevalue
field in descending order.
If you specify multiple fields, the fields must be separated by commas. For example, value:desc,updated_at:asc
would first sort results by the value
field in descending order and then by the updated_at
field in ascending order. |
RESPONSES
status: OK
{"values":[{"uuid":"0a6c1176-4c03-4776-a60a-048021a48799","created_at":"2018-12-31T15:39:16.687Z","created_by":"user3@example.com","updated_at":"2018-12-31T15:39:16.687Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Seattle","description":"","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":[]}},{"uuid":"18179e00-b0e0-4fd7-be91-e9e854fe66b9","created_at":"2018-12-31T16:10:21.710Z","created_by":"user3@example.com","updated_at":"2018-12-31T16:12:11.901Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Chicago","description":"Chicago Office New","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":[]}},{"uuid":"4a4627e8-6334-4ec7-a44d-414d6f510936","created_at":"2018-12-31T23:27:58.579Z","created_by":"user3@example.com","updated_at":"2018-12-31T23:27:58.579Z","updated_by":"user3@example.com","category_uuid":"ce8e96b5-4e4a-4469-99a6-425479153dea","value":"mac","type":"static","category_name":"operating_system","category_description":"The operating system of the asset","access_control":{"version":1,"current_user_permissions":[]}},{"uuid":"8e40f9c6-7a6a-4add-b92b-14f3de7f5c5e","created_at":"2018-12-31T15:40:49.110Z","created_by":"user3@example.com","updated_at":"2018-12-31T15:40:49.110Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"New York","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":[]}},{"uuid":"9e65d586-94d8-4b44-b3fd-2765385dfb0b","created_at":"2018-12-31T15:34:57.099Z","created_by":"user3@example.com","updated_at":"2018-12-31T15:34:57.099Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Austin","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":["CAN_EDIT"]}},{"uuid":"a270a97d-a5d4-400f-83fd-6f9e0bd44fc1","created_at":"2018-12-31T15:54:47.830Z","created_by":"user3@example.com","updated_at":"2018-12-31T15:54:47.830Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Rochester","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":["ALL","CAN_EDIT","CAN_SET_PERMISSIONS"]}},{"uuid":"cb12b269-862a-486d-88d2-c20e85d499b3","created_at":"2018-12-31T15:34:57.113Z","created_by":"user3@example.com","updated_at":"2018-12-31T15:34:57.113Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Portland","type":"static","category_name":"location","category_description":"Asset location","access_control":{"version":1,"current_user_permissions":["ALL","CAN_EDIT","CAN_SET_PERMISSIONS"]}}],"pagination":{"offset":0,"limit":5000,"total":10,"sort":[{"name":"category_name","order":"asc"}]}}