Table Of Contents

Previous topic

PADnsTXTRecord

Next topic

PAHostedDomain10

Application Packaging Standard

Last updated 18-Mar-2019

PAHostedDomain

The PAHostedDomain APS Type is used to create and manage DNS zones for the hosted domains.

Schema

The considered APS type (download) extends the HostedDomain, HostService APS type(s) and looks as follows:

{
  "name": "PAHostedDomain",
  "id": "http://parallels.com/aps/types/pa/dns/zone/1.1",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/dns/zone/1.1",
    "http://www.parallels.com/pa/pa-core-services/host-management/HostService/1.0"
  ],
  "relations": {
    "registrationInfo": {
      "type": "http://parallels.com/aps/types/pa/dns/zoneinfo/1.0"
    },
    "account": {
      "type": "http://parallels.com/aps/types/pa/account/1.0",
      "required": true
    }
  },
  "properties": {
    "zoneId": {
      "type": "integer",
      "final": true
    },
    "nameServers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dsRecord": {
      "type": "DSRecord"
    }
  },
  "structures": {
    "DSRecord": {
      "type": "object",
      "properties": {
        "algorithm": {
          "type": "integer"
        },
        "digestId": {
          "type": "integer"
        },
        "digest": {
          "type": "string"
        },
        "tag": {
          "type": "integer"
        }
      }
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
dsRecord DSRecord Not Required   DSRecord DSRecord
nameServers String array Not Required   List of name servers
zoneId Integer Not Required Final   Domain Zone id

Relationship

NAME TYPE REQUIRED DESCRIPTION
account PAAccount Yes Account related to this domain PAAccount
registrationInfo DomainRegistrationInfo No Registration information related to this domain DomainRegistrationInfo

Structures

DSRecord

DSRecord

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
algorithm Integer Not Required   Algorithm
digest String Not Required   Digest
digestId Integer Not Required   Dicest id
tag Integer Not Required   Tag

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at: