Search software

post

https://cloud.tenable.com/api/v1/t1/inventory/software/search

Returns a list of software installed on your assets 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

extra_properties

string

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

Use the List software properties endpoint to retrieve a list of valid properties for this parameter. For example, you might include cpe, version, and file_location 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 application:asc

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

Body Params

An object containing a query and/or filters to search for installed software on your assets.

query

object

Filter the search results by query. A query consists of search mode and query text.

filters

array of objects

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

Use the List software properties endpoint to view available software 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 software.

200Returned if the list of installed software was retrieved successfully.

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.