The <OptionProfile> element includes sub elements used to define an option profile. A reference of these elements is provided below. An asterisk * indicates a complex element.
Parameter |
Mandatory /Optional |
Data Type |
Description |
---|---|---|---|
id |
Optional |
integer |
The ID of the DNS override. |
name |
Optional |
text |
The name given to the DNS override. |
tags |
Optional |
text |
Filter by tags applied. |
tags.id |
Optional |
text |
ID of the tag assigned to DNS override. |
tags.name |
Optional |
integer |
Tag name assigned to DNS override. |
createdDate |
Optional |
date |
The date when the DNS override was created in WAS, in UTC date/time format. |
updatedDate |
Optional |
date |
The date when the DNS override was updated in WAS, in UTC date/time format. |
owner.id |
Optional |
boolean |
Long with operator: EQUALS, IN, NOT EQUALS, GREATER or LESSER) ID of the owner who created the DNS override. |
owner.name |
Optional |
boolean |
Full name of the user who created the DNS override. |
owner.username |
Optional |
keyword |
Username of the owner who created the DNS override. (like user_ab3). |
DnsMapping | keyword |
Use to configure the DNS override setting through API. You need to specify the hostname or FQDN and the corresponding IP address to be preferred for scanning. Example: <set> |
|
When you create a new DNS override, ensure: -Name (Required): Name should be unique. -Tags: The tag id should be valid and in scope of current user. Use only <Set> tag. -Mappings (Required): Each mapping must have hostName and IpAddress in valid format. Use only <Set> tag. -Comments: Only <Set> with 1 comment is allowed with maximum length 2048 characters. |
|||
When you update an DNS override, ensure: -Name: In case of name update, the updated name should be unique. -Id is required. -At lease one of the following should be present other than id: Name, owner, tags, comments, mappings -Tags: The <set> and <Add>/ <Removed> tags are mutually exclusive. Either use <set> or <Add> and <Removed>. - Mappings: The <set> and <Add>/ <Removed> tags are mutually exclusive. Either use <set> or <Add> and <Removed>. |