Application Packaging Standard

Last updated 18-Mar-2019

Hosted Domain

A resource of the HostedDomain type implements a Domain with DNS hosting properties.

A hosted domain contains a DNS record of the SOA type specified in the zone property.

In a particular management platform, it is possible to specify an external source of records (not managed by the platform) through the externalMaster property. In this case, this external master name server is responsible for the SOA and other DNS records of the domain, and the records collection of the HostedDomain resource should be empty.

In this document:

Schema

The HostedDomain schema: download

{
   "apsVersion": "2.0",

   "name": "HostedDomain",

   "id": "http://aps-standard.org/types/dns/zone/1.1",
   "implements": [ "http://aps-standard.org/types/dns/domain/1.0" ],

   "properties": {
      "zone": {
         "type": "DNSZone"
      },
      "masters": {
         "type": "array",
         "items": {
            "type": "string",
            "format": "ip-address"
         }
      },
      "externalMaster": {  // IP address - of external master DNS server, POA name-servers in slave mode
         "type": "string",
         "format": "ip-address"
      }
   },
   
   "structures": {
      "DNSZone": {
         "type": "object",
     
         "properties": {
            "adminEmail": {
               "type": "string",
               "required": false
            },
        
            "serial": {
               "type": "integer",
               "required": false
            },
            "refresh": {
               "type": "integer"
            },
            "retry": {
               "type": "integer"
            },
            "expire": {
               "type": "integer"
            },
            "TTL": {
               "type": "integer"
            }
          }
      }
   },
   
   "relations": {
      "records": {
         "type": "http://aps-standard.org/types/dns/record/1.0",
         "collection": true
      },
      "hosting":{
         "type":"http://aps-standard.org/types/core/subscription/1.0"
      },
      "parentDomain":{
         "type":"http://aps-standard.org/types/dns/zone/1.1"
      },
      "subdomains":{
         "type":"http://aps-standard.org/types/dns/zone/1.1",
         "collection":true
      }
   }
}

Properties

Property Description
zone SOA RR for the domain’s DNS zone
zone.adminEmail Email of the domain administrator from the record should match Admin_user of the domain’s account
masters (Obsolete) IP addresses of the internal master servers (obsoleted property)
externalMaster IP address of the external master DNS server

Note

The masters property is obsolete and should not be used in new packages.

Relations

RELATION TARGET
records Collection of resource records for the domain’s DNS zone.
hosting Parent subscription.
parentDomain Parent domain zone.
subdomains Collection of subdomains.
Domain