Retrieving the zone apex using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

REST Syntax

Click to view all REST Resources
Apex/ GET — Retrieves the FQDN apex information.

HTTP Action — GET

URI: Get one Zone — https://api.dynect.net/REST/Apex/<fqdn>/

Arguments:

No Arguments.

Response:

  • integer serial — The current serial number of the apex.
  • string serial_style — The style of the apex’s serial number.
    Valid values:
    increment – Serials are incremented by 1 on every change.
    epoch – Serials will be the UNIX timestamp at the time of the publish.
    day – Serials will be in the form of YYYYMMDDxx where xx is incremented by one for each change during that particular day.
    minute – Serials will be in the form of YYMMDDHHMM.
  • string apex The name of the requested apex.
  • string apex_type — Type of apex.
    Valid values:
    Primary
    Secondary

Dyn Logo

SOAP Syntax

Click to view all SOAP Commands
GetOneApex — Retrieve information on the specified apex.
Arguments:

GetOneApex:

string tokenRequired. The session identifier.

string apexRequired. Apex whose information will be retrieved.

Response:

  • hash data
      • string serial — The current serial number of the apex.
      • string serial_style — The style of the apex’s serial number.
        Valid values:
        increment – Serials are incremented by 1 on every change.
        epoch – Serials will be the UNIX timestamp at the time of the publish.
        day – Serials will be in the form of YYYYMMDDxx where xx is incremented by one for each change during that particular day.
        minute – Serials will be in the form of YYMMDDHHMM.
      • string apex The name of the requested apex.
      • string apex_type — Type of apex.

    Valid values:
    Primary
    Secondary

Example Request(GetOneApex) —

{
	'token' => 'asdlkfjasl23j4879afa',
	'apex' => 'example.com',
}