Table Of Contents

Previous topic

PAHostedDomain10

Next topic

GDPR Management

ReverseZoneManagement

The ReverseZoneManagement APS Type is used to manage the DNS reverse zones.

GraphViz

Schema

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

{
  "name": "ReverseZoneManagement",
  "id": "http://www.parallels.com/pa/pa-core-services/dns-reverse-zone-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {},
  "operations": {
    "addPtrRecord": {
      "path": "/records",
      "verb": "POST",
      "response": {
        "type": "PtrRecord"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "modifyPtrRecord": {
      "path": "/records",
      "verb": "PUT",
      "response": {
        "type": "PtrRecord"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "removePTRRecord": {
      "path": "/records/{recordIpAddr}",
      "verb": "DELETE",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "recordIpAddr": {
          "kind": "path",
          "type": "string"
        },
        "hostName": {
          "kind": "query",
          "type": "string"
        }
      }
    }
  },
  "structures": {
    "PtrRecord": {
      "type": "object",
      "properties": {
        "ipAddress": {
          "type": "string"
        },
        "hostName": {
          "type": "string"
        }
      }
    }
  }
}

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/dns-reverse-zone-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

addPtrRecord

POST

/records

If successful, this method returns the PtrRecord in the response body.

Add a PTR record.

modifyPtrRecord

PUT

/records

If successful, this method returns the PtrRecord in the response body.

Modify a PTR record.

removePTRRecord

DELETE

/records/{recordIpAddr}

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

Delete a PTR record.

addPtrRecord

HTTP Request

POST /aps/2/services/dns-reverse-zone-manager/records

Description

Add a PTR record.

Returns

If successful, this method returns the PtrRecord in the response body.

modifyPtrRecord

HTTP Request

PUT /aps/2/services/dns-reverse-zone-manager/records

Description

Modify a PTR record.

Returns

If successful, this method returns the PtrRecord in the response body.

removePTRRecord

HTTP Request

DELETE /aps/2/services/dns-reverse-zone-manager/records/{recordIpAddr}

Description

Delete a PTR record.

Parameters

PARAMETER

TYPE

DESCRIPTION

recordIpAddr

String

IP address

hostName

String

Hostname.

Returns

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

Structures

PtrRecord

PTR Record

NAME

TYPE

ATTRIBUTES

DEFAULT

DESCRIPTION

ipAddress

String

Not Required

IP address

hostName

String

Not Required

Hostname.

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.