Search Assets by Custom Field

GET https://{{API_URL}}/assets/search?status%5B%5D=open%26custom_fields%3Acustomfield1%5B%5D=JA

Request Params

KeyDatatypeRequiredDescription
application_idstringThe ID of an application to retrieve assets for. All other search parameters are ignored if application_id is provided.
exclude_child_filter[]stringarray of strings
If you want to include all assets regardless of vulnerability filters, pass a value of ["Include all assets"]; otherwise, omit this parameter.
id[]stringarray of integers
Array of asset IDs
max_prioritystringint32
Search for all assets that have a priority less than this value.
min_prioritystringint32
Search for all assets that have a priority greater than this value
max_risk_meter_scorestringint32
Search for all assets that have a risk meter score less than this value.
min_risk_meter_scorestringint32
Search for all assets that have a risk meter score greater than this value.
operating_system[]stringarray of strings
An array of the names of the operating systems associated with a set of assets.
primary_locator[]stringarray of strings
The primary locator used for an asset. This should be one of the following values: ip_address, hostname, database, url, mac_address, netbios, fqdn, file, or application
service_names[]stringarray of strings
An array of service names relating to your assets. Make sure all letters are lowercase.
service_ports[]stringarray of strings
An array of ports relating to your assets.
service_products[]stringarray of integers
An array of service products relating to your assets. Make sure all letters are lowercase.
service_protocols[]stringarray of strings
An array of service protocols relating to your assets. Make sure all letters are lowercase.
status[]stringarray of strings
An array of statuses for your assets which can include active and/or inactive. NOTE: By default, only active assets are returned when searching. You must specify the asset status you want in order to override that default.
search_idstringint32
Search values specified in the risk meter group definition will override their respective values provided in this request when search_id is provided.
tag_boolean_modestringstring
Set this to 'all' if you would like to return assets that contain all of the tags in your query rather than assets that contain any of the tags.
tags[]stringarray of strings
An array of tag names associated with your assets.
vulnerabilitystringVulnerability ids. Search for all assets that have vulnerabilities with these ids.
status%5B%5Dstring