Search Assets by Custom Field
GET https://{{API_URL}}/assets/search?status%5B%5D=open%26custom_fields%3Acustomfield1%5B%5D=JA
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
application_id | string | The ID of an application to retrieve assets for. All other search parameters are ignored if application_id is provided. | |
exclude_child_filter[] | string | array 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[] | string | array of integers | |
Array of asset IDs | |||
max_priority | string | int32 | |
Search for all assets that have a priority less than this value. | |||
min_priority | string | int32 | |
Search for all assets that have a priority greater than this value | |||
max_risk_meter_score | string | int32 | |
Search for all assets that have a risk meter score less than this value. | |||
min_risk_meter_score | string | int32 | |
Search for all assets that have a risk meter score greater than this value. | |||
operating_system[] | string | array of strings | |
An array of the names of the operating systems associated with a set of assets. | |||
primary_locator[] | string | array 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[] | string | array of strings | |
An array of service names relating to your assets. Make sure all letters are lowercase. | |||
service_ports[] | string | array of strings | |
An array of ports relating to your assets. | |||
service_products[] | string | array of integers | |
An array of service products relating to your assets. Make sure all letters are lowercase. | |||
service_protocols[] | string | array of strings | |
An array of service protocols relating to your assets. Make sure all letters are lowercase. | |||
status[] | string | array 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_id | string | int32 | |
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_mode | string | string | |
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[] | string | array of strings | |
An array of tag names associated with your assets. | |||
vulnerability | string | Vulnerability ids. Search for all assets that have vulnerabilities with these ids. | |
status%5B%5D | string |