DocumentationAPI ReferenceRelease Notes
API Reference

Search assets

Searches for assets based on specified criteria with optional pagination support.

Required Permission(s)

  • Asset Management (Read)

Notes

  • At least one request body property should be provided; any property not provided is ignored. All search criteria is case insensitive and is an exact match (equality), except for IPAddress
  • IPAddress can be a single IP address (10.0.0.1), a comma-delimited list of IPs (10.0.0.1,10.0.0.2,10.0.0.3), an IP range (10.0.0.1-10.0.0.25), or CIDR notation (10.0.0.0/24).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

(default: 100000) Optional maximum number of results to return for pagination

int32
Defaults to 0

Number of records to skip for pagination (can only be used in conjunction with limit)

Body Params

Search criteria. At least one request body property should be provided; any
property not provided is ignored. All search criteria is case insensitive and is an exact match (equality), except for IPAddress

At least one request body property should be provided; any property not provided is
ignored. All search criteria is case insensitive and is an exact match (equality),
except for IPAddress.

string | null

Asset IP address - can be a single IP address (10.0.0.1), a comma-delimited list of IPs (10.0.0.1,10.0.0.2,10.0.0.3),
an IP range (10.0.0.1-10.0.0.25), or CIDR notation (10.0.0.0/24)

string | null

Asset name. If not given, a padded IP address is used

string | null

Asset type

string | null

Asset DNS name

string | null

Asset domain name

string | null

Asset operating system

This property is ignored in Search requests

string | null

Asset description. Only updated if version in the URL is 3.1 or greater

This property is ignored in Search requests

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.