Create Risk Meter from Custom Field
POST https://{{API_URL}}/asset_groups
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
**All fields below are to updated in Body Params** | null | All fields below are to updated in Body Params | |
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 | |
min_priority | string | int32 - Search for all assets that have a priority greater than this value. | |
max_priority | string | int32 - Search for all assets that have a priority 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 | |
q | string | string - This can be any query string you want to search for, including a regex. We also have our own search syntax that enables you to search assets based on specific locators and fields. For more detailed documentation on our search syntax visit our Help Center. Below is an example of our search syntax being used to find all assets with the hostname foobar. As stated in our Help Center, it is also possible to use our search syntax on vulnerability fields. In order to apply a query for a vulnerability field to an asset search you must nest the query string under a vulnerability key. The example below shows how to search for all assets that relate to vulnerabilities that are connected to the Heartbleed CVE. | |
service_ports[] | string | array of strings - An array of ports relating to your assets. | |
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. | |
tags[] | string | array of strings - An array of tag names associated with your assets. | |
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. For example, if you want to return all assets the have the tag foo and the tag bar your request would look like this: | |
vulnerability: {id: []} | string | array of integers - Vulnerability ids. Search for all assets that have vulnerabilities with these ids. |
Request Body
{"asset_group"=>{"name"=>"Custom Field Test", "query"=>{"status"=>["active"], "vulnerability"=>{"custom_fields"=>"Custom Field Dummy:Example custom field text"}}}}