Search DNS Override
Returns a list of DNS overrides which are in the user’s scope. Action logs are not included in the output.
Permissions required: User must have WAS module enabled. User account must have these permissions:
Access Permission: API Access
The Output includes DNS overrides in the user's scope.
Input ParametersInput Parameters
These elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND.
Click here for available operators
|
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 |
|
Filter by tags applied. |
|
tags.id |
Optional |
integer |
ID of the tag assigned to DNS override. |
|
tags.name |
Optional |
text |
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 |
Long with operator: EQUALS, IN, NOT EQUALS, GREATER or LESSER |
ID of the owner who created the DNS override. |
|
owner.name |
Optional |
text |
Full name of the user who created the DNS override. |
|
owner.username |
Optional |
text |
Username of the owner who created the DNS override. (like user_ab3). |
Sample - Search - criteria (POST)Sample - Search - criteria (POST)
API request:
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST"--data-binary@-
"<qualys_base_url>/qps/rest/3.0/get/was/dnsoverride/" < file.xml
Note: "file.xml" contains the request POST data.
Request POST data:
<ServiceRequest>
<filters>
<Criteria field="name" operator="CONTAINS">Test API</Criteria>
</filters>
</ServiceRequest>
XML response:
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/xsd/3.0/was/dnsoverride.xsd">
<responseCode>SUCCESS</responseCode>
<count>6</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<DnsOverride>
<id>56420</id>
<name>
<![CDATA[Test API DNS Record]]>
</name>
<owner>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>0</count>
</tags>
<createdDate>2019-08-12T13:33:04Z</createdDate>
<updatedDate>2019-08-12T13:33:04Z</updatedDate>
</DnsOverride>
<DnsOverride>
<id>56422</id>
<name>
<![CDATA[Test API Dns Record1]]>
</name>
<owner>
<id>1056860</id>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>0</count>
</tags>
<createdDate>2019-08-12T13:58:59Z</createdDate>
<updatedDate>2019-08-12T13:58:59Z</updatedDate>
</DnsOverride>
<DnsOverride>
<id>56423</id>
<name>
<![CDATA[Test API Dns Record2]]>
</name>
<owner>
<id>1056860</id>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>2</count>
</tags>
<createdDate>2019-08-12T15:30:24Z</createdDate>
<updatedDate>2019-08-12T15:30:30Z</updatedDate>
</DnsOverride>
<DnsOverride>
<id>56621</id>
<name>
<![CDATA[Test API Dns Record3]]>
</name>
<owner>
<id>1056860</id>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>2</count>
</tags>
<createdDate>2019-08-12T23:03:53Z</createdDate>
<updatedDate>2019-08-12T23:03:59Z</updatedDate>
</DnsOverride>
<DnsOverride>
<id>56820</id>
<name>
<![CDATA[Test API Dns Record3-Updated]]>
</name>
<owner>
<id>1056860</id>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>0</count>
</tags>
<createdDate>2019-08-13T00:07:37Z</createdDate>
<updatedDate>2019-08-16T14:10:18Z</updatedDate>
</DnsOverride>
<DnsOverride>
<id>57020</id>
<name>
<![CDATA[Test API Dns Record4]]>
</name>
<owner>
<id>1056860</id>
<username>user_john</username>
<firstName>
<![CDATA[John]]>
</firstName>
<lastName>
<![CDATA[Doe]]>
</lastName>
</owner>
<tags>
<count>1</count>
</tags>
<createdDate>2019-08-19T16:25:05Z</createdDate>
<updatedDate>2019-08-22T12:35:40Z</updatedDate>
</DnsOverride>
</data>
</ServiceResponse>
XSD
<platform API server>/qps/xsd/3.0/was/dnsoverride.xsd