DomainManagement

This type represents the platform built-in Domain Management Service that exposes common operations over domains.

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "DomainManagement",
  "id": "http://www.parallels.com/pa/pa-core-services/domain-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "getDNSHostingSubscriptions": {
      "path": "domain/hostingSubscriptions",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "getDNSHostingServiceTemplates": {
      "path": "domain/hostingServiceTemplates",
      "verb": "GET",
      "response": {
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "validateDomain": {
      "path": "domain/validate",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    },
    "checkElsewhereAvailability": {
      "path": "domain/elsewhere/check",
      "verb": "POST",
      "response": {
        "type": "boolean"
      },
      "errorResponse": {
        "type": "object"
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
checkElsewhereAvailability	POST	domain/elsewhere/check	If successful, this method returns the 200 OK standard status code.	Check availability of the specified domains.
getDNSHostingServiceTemplates	GET	domain/hostingServiceTemplates	If successful, this method returns a list of PAServiceTemplate objects in the response body.	Get a list of service templates containing a DNS hosting resource type. The operation is available for the provider staff only. Otherwise, the method returns the error message “Unauthenticated call, only provider can get access method”.
getDNSHostingSubscriptions	GET	domain/hostingSubscriptions	If successful, this method returns a list of Subscription objects in the response body.	Get a list of subscriptions containing a DNS hosting resource. The operation is available for the provider staff only. Otherwise, the method returns the error message “Unauthenticated call, only provider can get access method”.
validateDomain	POST	domain/validate	If successful, this method returns the 200 OK standard status code.	Validate a domain against internal conditions and passed parameters.

checkElsewhereAvailability

HTTP Request

POST /aps/2/resources/{aps-id}/domain/elsewhere/check

Description

Check availability of the specified domains.

Parameters

PARAMETER	TYPE	DESCRIPTION
parameters	Map of String	Map of domain name and TLD.

Returns

If successful, this method returns the 200 OK standard status code.

getDNSHostingServiceTemplates

HTTP Request

GET /aps/2/resources/{aps-id}/domain/hostingServiceTemplates

Description

Get a list of service templates containing a DNS hosting resource type. The operation is available for the provider staff only. Otherwise, the method returns the error message “Unauthenticated call, only provider can get access method”.

Returns

If successful, this method returns a list of PAServiceTemplate objects in the response body.

getDNSHostingSubscriptions

HTTP Request

GET /aps/2/resources/{aps-id}/domain/hostingSubscriptions

Description

Get a list of subscriptions containing a DNS hosting resource. The operation is available for the provider staff only. Otherwise, the method returns the error message “Unauthenticated call, only provider can get access method”.

Returns

If successful, this method returns a list of Subscription objects in the response body.

validateDomain

HTTP Request

POST /aps/2/resources/{aps-id}/domain/validate

Description

Validate a domain against internal conditions and passed parameters.

Parameters

PARAMETER	TYPE	DESCRIPTION
parameters	Map of String	Map of domain name and TLD.

Returns

If successful, this method returns the 200 OK standard status code.

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← Domain Management

DomainRegistrationInfo →