CloudBlue Commerce API (DRAFT)
Table Of Contents
DomainManagement¶
This type represents the platform built-in Domain Management Service that exposes common operations over domains.
In this document:
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.1",
"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"
}
},
"getDSRecord": {
"path": "domain/elsewhere/dnssec",
"verb": "GET",
"response": {
"type": "DSRecordDto"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"name": {
"kind": "query",
"type": "string"
}
}
},
"configureDNSSec": {
"path": "domain/elsewhere/dnssec",
"verb": "PUT",
"response": {
"type": "DSRecordDto"
},
"errorResponse": {
"type": "object"
}
}
},
"structures": {
"DSRecord": {
"type": "object",
"properties": {
"algorithm": {
"type": "integer"
},
"digestId": {
"type": "integer"
},
"digest": {
"type": "string"
},
"tag": {
"type": "integer"
}
}
},
"DSRecordDto": {
"type": "object",
"properties": {
"dsRecord": {
"type": "DSRecord"
},
"isAllowed": {
"type": "boolean"
}
}
}
}
}
The APS type is used to create a singleton APS resource exposing its operations for API calls. The call syntax depends on the operation. For example, a call of an operation that accepts input parameters both in the URL string and in the body looks as follows:
POST /aps/2/services/domain-manager/<operation-path>?<query-params>
{/*<body params>*/}
In the above call, the verb can be either GET, PUT, POST, or DELETE as specified in the definition of the operation.
Custom Operations¶
OPERATION |
VERB |
PATH |
RETURNS |
Description |
|---|---|---|---|---|
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”. |
|
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”. |
|
POST |
/domain/validate |
If successful, this method returns the 200 OK standard status code. |
Validate a domain against internal conditions and passed parameters. |
|
POST |
/domain/elsewhere/check |
If successful, this method returns the 200 OK standard status code. |
Check availability of the specified domains. |
|
GET |
/domain/elsewhere/dnssec |
If successful, this method returns the DSRecordDto. |
GET DNSSec delegation signer record of the specified domain. |
|
PUT |
/domain/elsewhere/dnssec |
If successful, this method returns the DSRecordDto. |
Update DNSSec of the specified domain. |
getDNSHostingSubscriptions¶
HTTP Request
GET /aps/2/services/domain-manager/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.
getDNSHostingServiceTemplates¶
HTTP Request
GET /aps/2/services/domain-manager/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.
validateDomain¶
HTTP Request
POST /aps/2/services/domain-manager/domain/validate
Description
Validate a domain against internal conditions and passed parameters.
Returns
If successful, this method returns the 200 OK standard status code.
checkElsewhereAvailability¶
HTTP Request
POST /aps/2/services/domain-manager/domain/elsewhere/check
Description
Check availability of the specified domains.
Returns
If successful, this method returns the 200 OK standard status code.
getDSRecord¶
HTTP Request
GET /aps/2/services/domain-manager/domain/elsewhere/dnssec
Description
GET DNSSec delegation signer record of the specified domain.
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
name |
String |
Returns
If successful, this method returns the DSRecordDto.
configureDNSSec¶
HTTP Request
PUT /aps/2/services/domain-manager/domain/elsewhere/dnssec
Description
Update DNSSec of the specified domain.
Returns
If successful, this method returns the DSRecordDto.
Structures¶
DSRecord¶
DSRecord.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
algorithm |
Integer |
Not Required |
Algorithm. |
|
digestId |
Integer |
Not Required |
Dicest id |
|
digest |
String |
Not Required |
Digest. |
|
tag |
Integer |
Not Required |
Tag. |
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.