ReverseZoneManagement

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

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"
        }
      }
    }
  }
}

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/resources/{aps-id}/records

Description

Add a PTR record.

Parameters

PARAMETER	TYPE	DESCRIPTION
apsEntityId		Id of user performing the operation
record	PtrRecord	PTR record data

Returns

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

modifyPtrRecord

HTTP Request

PUT /aps/2/resources/{aps-id}/records

Description

Modify a PTR record.

Parameters

PARAMETER	TYPE	DESCRIPTION
apsEntityId		Id of user performing the operation
record	PtrRecord	PTR record data

Returns

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

removePTRRecord

HTTP Request

DELETE /aps/2/resources/{aps-id}/records/{recordIpAddr}

Description

Delete a PTR record.

Parameters

PARAMETER	TYPE	DESCRIPTION
apsEntityId		Id of user performing the operation
hostName	String	Hostname
recordIpAddr	String	IP address

Returns

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

Structures

PtrRecord

PTR Record

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
hostName	String	Not Required		Hostname
ipAddress	String	Not Required		IP address

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.

← PAHostedDomain10

GDPR Management →