Understanding How The API Works »
Updating Zone settings in 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 |
Zone/ PUT — Freeze, Thaw, or Publish pending zone changes.
HTTP Action — PUT
URI — https://api.dynect.net/REST/Zone/<zone>/ |
Arguments:
Only one of these choices may be specified:
boolean freeze — Causes the zone to become frozen. Freezing a zone prevents changes to the zone until it is thawed.
boolean thaw — Causes the zone to become thawed. Thawing a frozen zone allows changes to again be made to the zone.
boolean publish — Causes all pending changes to become part of the zone. The serial number increments based on its serial style and the data is pushed out to the nameservers.
string notes — A custom note field. All content in the string is added to the Zone Notes when the zone is published. Only supported for use with boolean publish .
|
Response:
freeze — Not Applicable.
thaw — Not Applicable.
publish — Click for More Info
- integer
task_id — The number assigned to the task to publish the zone update.
- integer
serial — The current serial number of the zone.
- string
serial_style — The style in which serial numbers are generated for this zone.
Valid values: increment, epoch, day, minute
- string
zone — The name of the zone.
- string
zone_type — Indicates whether the zone is Primary or Secondary.
|
SOAP Syntax
Click to view all SOAP Commands |
FreezeZone — Causes the zone to become frozen. Freezing a zone prevents changes to the zone until it is thawed.
ThawZone — Causes the zone to become thawed. Thawing a frozen zone allows changes to again be made to the zone.
PublishZone — Causes all pending changes to become part of the zone. |
Arguments:
FreezeZone Arguments:
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone to freeze.
ThawZone Arguments:
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone to thaw.
PublishZone Arguments:
- string
token — Required. The session identifier.
- string
zone — Required. Name of zone to publish.
- string
notes — A custom note field. All content in the string is added to the Zone Notes when the zone is published.
|
Response:
freeze — Not Applicable.
thaw — Not Applicable.
publish — Click for More Info
- hash
data
- integer
task_id — The number assigned to the task to publish the zone update.
- integer
serial — The current serial number of the zone.
- string
serial_style — The style in which serial numbers are generated for this zone.
Valid values: increment, epoch, day, minute
- string
zone — The name of the zone.
- string
zone_type — Indicates whether the zone is Primary or Secondary.
|
Example Request (for all 3 Commands) — Click for More Info
{
'token' => 'zaq12wsxcDe34rf89gt56nh',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base