DNS Zone Operations

This section documents the API operations for DNS Zone service.

GetDNSTemplate

GetDNSTemplateRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS template request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ clientId	common:idType	Client id
└ DNSTemplateName	common:string255	DNS template name

XSD Source

xml

<xs:element name="GetDNSTemplateRequest">
  <xs:annotation>
    <xs:documentation>Get DNS template request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="clientId" type="common:idType" minOccurs="0"/>
          <xs:element name="DNSTemplateName" type="common:string255" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetDNSTemplateResponse

Type: messagesInfo:GetDNSTemplateResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS template response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetDNSTemplateResponse" type="messagesInfo:GetDNSTemplateResponseType">
  <xs:annotation>
    <xs:documentation>Get DNS template response.</xs:documentation>
  </xs:annotation>
</xs:element>

AddDNSZone

AddDNSZoneRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add DNS zone request.

Properties

Property	Value
content	complex

Extends

Base type: data:DNSZoneInfo

Elements

Element	Type	Description
clientId	common:idType (optional)	Client id

XSD Source

xml

<xs:element name="AddDNSZoneRequest">
  <xs:annotation>
    <xs:documentation>Add DNS zone request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:DNSZoneInfo">
          <xs:sequence>
            <xs:element name="clientId" type="common:idType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Client id</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddDNSZoneResponse

Type: messagesInfo:UpdateDNSZoneResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add DNS zone response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="AddDNSZoneResponse" type="messagesInfo:UpdateDNSZoneResponseType">
  <xs:annotation>
    <xs:documentation>Add DNS zone response.</xs:documentation>
  </xs:annotation>
</xs:element>

EditDNSZone

EditDNSZoneRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS zone request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
name	common:string255	DNS zone name
type	inline (optional)	DNS zone type: 'master' or 'slave'
IPs	common:ipAddress (0..*)	{type} DNS servers IP addresses
status	common:boolean (optional)

XSD Source

xml

<xs:element name="EditDNSZoneRequest">
  <xs:annotation>
    <xs:documentation>Edit DNS zone request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="name" type="common:string255">
          <xs:annotation>
            <xs:documentation>DNS zone name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="type" minOccurs="0">
          <xs:annotation>
            <xs:documentation>DNS zone type: 'master' or 'slave'</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="IPs" type="common:ipAddress" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>{type} DNS servers IP addresses</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="status" type="common:boolean" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

EditDNSZoneResponse

Type: messagesInfo:UpdateDNSZoneResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS zone response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditDNSZoneResponse" type="messagesInfo:UpdateDNSZoneResponseType">
  <xs:annotation>
    <xs:documentation>Edit DNS zone response.</xs:documentation>
  </xs:annotation>
</xs:element>

GetDNSZone

GetDNSZoneRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS zone list request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ clientId	common:idType	Client id
└ DNSZoneName	common:string255	DNS zone name

XSD Source

xml

<xs:element name="GetDNSZoneRequest">
  <xs:annotation>
    <xs:documentation>Get DNS zone list request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="clientId" type="common:idType" minOccurs="0"/>
          <xs:element name="DNSZoneName" type="common:string255" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetDNSZoneResponse

Type: messagesInfo:GetDNSZoneResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS zone response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetDNSZoneResponse" type="messagesInfo:GetDNSZoneResponseType">
  <xs:annotation>
    <xs:documentation>Get DNS zone response.</xs:documentation>
  </xs:annotation>
</xs:element>

DelDNSZone

DelDNSZoneRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS zone request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
DNSZoneName	common:string255 (1..*)	DNS zone name

XSD Source

xml

<xs:element name="DelDNSZoneRequest">
  <xs:annotation>
    <xs:documentation>Delete DNS zone request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="DNSZoneName" type="common:string255" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>DNS zone name</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelDNSZoneResponse

Type: messagesInfo:DelDNSZoneResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS zone response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelDNSZoneResponse" type="messagesInfo:DelDNSZoneResponseType">
  <xs:annotation>
    <xs:documentation>Delete DNS zone response.</xs:documentation>
  </xs:annotation>
</xs:element>

AddDNSRecord

AddDNSRecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add DNS record request.

Properties

Property	Value
content	complex

Extends

Base type: data:DNSRecordInfo

Elements

Element	Type	Description
DNSZoneName	common:string255	DNS zone name

XSD Source

xml

<xs:element name="AddDNSRecordRequest">
  <xs:annotation>
    <xs:documentation>Add DNS record request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:DNSRecordInfo">
          <xs:sequence>
            <xs:element name="DNSZoneName" type="common:string255">
              <xs:annotation>
                <xs:documentation>DNS zone name</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddDNSRecordResponse

Type: messagesInfo:UpdateDNSRecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add DNS record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="AddDNSRecordResponse" type="messagesInfo:UpdateDNSRecordResponseType">
  <xs:annotation>
    <xs:documentation>Add DNS record response.</xs:documentation>
  </xs:annotation>
</xs:element>

EditDNSRecord

EditDNSRecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS record request.

Properties

Property	Value
content	complex

Extends

Base type: data:DNSRecordInfo

Elements

Element	Type	Description
DNSRecordId	common:idType	DNS record id

XSD Source

xml

<xs:element name="EditDNSRecordRequest">
  <xs:annotation>
    <xs:documentation>Edit DNS record request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:DNSRecordInfo">
          <xs:sequence>
            <xs:element name="DNSRecordId" type="common:idType">
              <xs:annotation>
                <xs:documentation>DNS record id</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditDNSRecordResponse

Type: messagesInfo:UpdateDNSRecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditDNSRecordResponse" type="messagesInfo:UpdateDNSRecordResponseType">
  <xs:annotation>
    <xs:documentation>Edit DNS record response.</xs:documentation>
  </xs:annotation>
</xs:element>

GetDNSRecord

GetDNSRecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS record request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ DNSRecordId	common:idType	DNS record id
└ DNSZoneName	common:string255	DNS zone name
└ filter	common:string255	Filter DNS records by host, value
└ RecordType	inline	DNS Record type : 'A', 'AAAA', 'NS', 'CNAME', 'MX', 'TXT', 'SRV', 'PTR', 'NAPTR' or 'CAA'

XSD Source

xml

<xs:element name="GetDNSRecordRequest">
  <xs:annotation>
    <xs:documentation>Get DNS record request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="DNSRecordId" type="common:idType" minOccurs="0"/>
          <xs:element name="DNSZoneName" type="common:string255" minOccurs="0"/>
          <xs:element name="filter" type="common:string255" minOccurs="0"/>
          <xs:element name="RecordType" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetDNSRecordResponse

Type: messagesInfo:GetDNSRecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetDNSRecordResponse" type="messagesInfo:GetDNSRecordResponseType">
  <xs:annotation>
    <xs:documentation>Get DNS record response.</xs:documentation>
  </xs:annotation>
</xs:element>

DelDNSRecord

DelDNSRecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS record request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
DNSRecord	inline (1..*)

XSD Source

xml

<xs:element name="DelDNSRecordRequest">
  <xs:annotation>
    <xs:documentation>Delete DNS record request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="DNSRecord" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelDNSRecordResponse

Type: messagesInfo:DelDNSRecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelDNSRecordResponse" type="messagesInfo:DelDNSRecordResponseType">
  <xs:annotation>
    <xs:documentation>Delete DNS record response.</xs:documentation>
  </xs:annotation>
</xs:element>

EditSOARecord

EditSOARecordRequest

Type: data:SOARecordInfo

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS zone SOA record request.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditSOARecordRequest" type="data:SOARecordInfo">
  <xs:annotation>
    <xs:documentation>Edit DNS zone SOA record request.</xs:documentation>
  </xs:annotation>
</xs:element>

EditSOARecordResponse

Type: messagesInfo:UpdateSOARecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit DNS zone SOA record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditSOARecordResponse" type="messagesInfo:UpdateSOARecordResponseType">
  <xs:annotation>
    <xs:documentation>Edit DNS zone SOA record response.</xs:documentation>
  </xs:annotation>
</xs:element>

GetSOARecord

GetSOARecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS zone SOA record list request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
DNSZoneName	common:string255	DNS zone name

XSD Source

xml

<xs:element name="GetSOARecordRequest">
  <xs:annotation>
    <xs:documentation>Get DNS zone SOA record list request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="DNSZoneName" type="common:string255">
          <xs:annotation>
            <xs:documentation>DNS zone name</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetSOARecordResponse

Type: messagesInfo:GetSOARecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get DNS zone SOA record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetSOARecordResponse" type="messagesInfo:GetSOARecordResponseType">
  <xs:annotation>
    <xs:documentation>Get DNS zone SOA record response.</xs:documentation>
  </xs:annotation>
</xs:element>

DelSOARecord

DelSOARecordRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS zone SOA record request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
DNSZoneName	common:string255	DNS zone name

XSD Source

xml

<xs:element name="DelSOARecordRequest">
  <xs:annotation>
    <xs:documentation>Delete DNS zone SOA record request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="DNSZoneName" type="common:string255">
          <xs:annotation>
            <xs:documentation>DNS zone name</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelSOARecordResponse

Type: messagesInfo:DelSOARecordResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete DNS zone SOA record response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelSOARecordResponse" type="messagesInfo:DelSOARecordResponseType">
  <xs:annotation>
    <xs:documentation>Delete DNS zone SOA record response.</xs:documentation>
  </xs:annotation>
</xs:element>

AddRemoteURL

AddRemoteURLRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add remote update location request.

Properties

Property	Value
content	complex

Extends

Base type: data:RemoteURLInfo

Elements

Element	Type	Description
clientId	common:idType (optional)	Client id

XSD Source

xml

<xs:element name="AddRemoteURLRequest">
  <xs:annotation>
    <xs:documentation>Add remote update location request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:RemoteURLInfo">
          <xs:sequence>
            <xs:element name="clientId" type="common:idType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Client id</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AddRemoteURLResponse

Type: messagesInfo:UpdateRemoteURLResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Add remote update location response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="AddRemoteURLResponse" type="messagesInfo:UpdateRemoteURLResponseType">
  <xs:annotation>
    <xs:documentation>Add remote update location response.</xs:documentation>
  </xs:annotation>
</xs:element>

EditRemoteURL

EditRemoteURLRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit remote update location request.

Properties

Property	Value
content	complex

Extends

Base type: data:RemoteURLInfo

Elements

Element	Type	Description
URLId	common:idType (optional)	Remote update location id
status	common:boolean (optional)

XSD Source

xml

<xs:element name="EditRemoteURLRequest">
  <xs:annotation>
    <xs:documentation>Edit remote update location request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="data:RemoteURLInfo">
          <xs:sequence>
            <xs:element name="URLId" type="common:idType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Remote update location id</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="status" type="common:boolean" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditRemoteURLResponse

Type: messagesInfo:UpdateRemoteURLResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Edit remote update location response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="EditRemoteURLResponse" type="messagesInfo:UpdateRemoteURLResponseType">
  <xs:annotation>
    <xs:documentation>Edit remote update location response.</xs:documentation>
  </xs:annotation>
</xs:element>

GetRemoteURL

GetRemoteURLRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get remote update location request

Properties

Property	Value
content	complex

Elements

Element	Type	Description
(choice)		Either of
└ clientId	common:idType	Client id
└ URLId	common:idType	Remote update location id
└ remoteURL	common:domainType	Remote update location

XSD Source

xml

<xs:element name="GetRemoteURLRequest">
  <xs:annotation>
    <xs:documentation>Get remote update location request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="clientId" type="common:idType" minOccurs="0"/>
          <xs:element name="URLId" type="common:idType" minOccurs="0"/>
          <xs:element name="remoteURL" type="common:domainType" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetRemoteURLResponse

Type: messagesInfo:GetRemoteURLResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Get remote update location response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="GetRemoteURLResponse" type="messagesInfo:GetRemoteURLResponseType">
  <xs:annotation>
    <xs:documentation>Get remote update location response.</xs:documentation>
  </xs:annotation>
</xs:element>

DelRemoteURL

DelRemoteURLRequest

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete remote update location request.

Properties

Property	Value
content	complex

Elements

Element	Type	Description
URLId	common:idType (1..*)	Remote update location id

XSD Source

xml

<xs:element name="DelRemoteURLRequest">
  <xs:annotation>
    <xs:documentation>Delete remote update location request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="URLId" type="common:idType" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Remote update location id</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelRemoteURLResponse

Type: messagesInfo:DelRemoteURLResponseType

Namespace: http://4psa.com/DNSZoneMessages.xsd/1.5

Description: Delete remote update location response.

Properties

Property	Value
content	complex

XSD Source

xml

<xs:element name="DelRemoteURLResponse" type="messagesInfo:DelRemoteURLResponseType">
  <xs:annotation>
    <xs:documentation>Delete remote update location response.</xs:documentation>
  </xs:annotation>
</xs:element>

DNS Zone Operations ​

GetDNSTemplate ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

AddDNSZone ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

EditDNSZone ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetDNSZone ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

DelDNSZone ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

AddDNSRecord ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

EditDNSRecord ​

Properties ​

Extends ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

GetDNSRecord ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

DelDNSRecord ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

EditSOARecord ​

Properties ​

XSD Source ​

Properties ​

XSD Source ​

GetSOARecord ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

DelSOARecord ​

Properties ​

Elements ​

XSD Source ​

Properties ​

XSD Source ​

AddRemoteURL ​

Properties ​

Extends ​

Elements ​

XSD Source ​

DNS Zone Operations

GetDNSTemplate

Properties

Elements

XSD Source

Properties

XSD Source

AddDNSZone

Properties

Extends

Elements

XSD Source

Properties

XSD Source

EditDNSZone

Properties

Elements

XSD Source

Properties

XSD Source

GetDNSZone

Properties

Elements

XSD Source

Properties

XSD Source

DelDNSZone

Properties

Elements

XSD Source

Properties

XSD Source

AddDNSRecord

Properties

Extends

Elements

XSD Source

Properties

XSD Source

EditDNSRecord

Properties

Extends

Elements

XSD Source

Properties

XSD Source

GetDNSRecord

Properties

Elements

XSD Source

Properties

XSD Source

DelDNSRecord

Properties

Elements

XSD Source

Properties

XSD Source

EditSOARecord

Properties

XSD Source

Properties

XSD Source

GetSOARecord

Properties

Elements

XSD Source

Properties

XSD Source

DelSOARecord

Properties

Elements

XSD Source

Properties

XSD Source

AddRemoteURL

Properties

Extends

Elements

XSD Source