Search tags

post

https://cloud.tenable.com/api/v1/t1/tags/search

Returns a list of tags in your organization that match the specified search criteria.

Caution: This endpoint is available for use but is currently in beta. The response structure is subject to change as we continue to enhance the data model.

Requires the Basic [16] user role or the ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ and AD.TOGGLE_AD.USE custom role privileges. See Roles.

Query Params

extra_properties

string

Specifies extra tag properties to include in the search results. You can provide multiple properties as a comma-separated list.

Use the List tag properties endpoint to retrieve a list of valid properties for this parameter. For example, you might include tag_data_source, last_updated, and tag_created_by_id as extra properties.

offset

integer

Defaults to 0

The starting record to retrieve. If omitted, the default value is 0.

limit

integer

≤ 1000

Defaults to 1000

The number of records to retrieve. If omitted, the default value is 1000. The maximum value is 1000.

sort

string

Defaults to total_weakness_count:desc

The property and direction to sort the results by, in the format property:direction. For example: tag_name:asc or last_updated:desc

Body Params

query

object

The search mode and query text.

filters

array of objects

A set of tag properties used to filter the search results.

Use the List tag properties endpoint to view available tag properties that can be used as filters.

filters

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Returned if you do not have permission to search tags.

Language

Credentials

Header

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Returned if Tenable One successfully retrieved the list of assets.

400Returned if your request specified invalid parameters or if your request was improperly formatted.

401Returned if the API keys specified in your request are invalid.

429Returned if you attempt to send too many requests in a specific period of time. For more information, see Rate Limiting.

500Returned if an internal error occurred in Tenable One.