Knowledge Base
Categories: DNS API
Modify SOA Records Using the API
When you want to update a Start of Authority (SOA) DNS record. This article explains how to modify SOA record settings such as responsible email address, refresh interval, retry interval, expiry duration, and TTL values using the API.
Description
Modifies a Start of Authority (SOA) record.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | Domain name for which you want to modify a SOA record |
| responsible-person | String | Required | The email address of the person responsible for maintenance of the Zone |
| refresh | Integer | Required | The number of seconds after which the Secondary DNS Server checks the Primary DNS Server to check if the Zone has changed. Value should not be less than 7200, i.e., 2 hours. |
| retry | Integer | Required | Number of seconds that should elapse before a failed refresh should be retried. Value should not be less than 7200, i.e., 2 hours. |
| expire | Integer | Required | Number of seconds that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative. Value should not be less than 172800, i.e., 48 hours. |
| ttl | Integer | Required | Number of seconds the record needs to be cached by the DNS Resolvers. Value should not be less than 14400, i.e., 4 hours. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/dns/manage/update-soa-record.json?auth-userid=0&api-key=key&domain-name=domain.com&responsible-person=admin@domain.com&refresh=7200&retry=7200&expire=172800&ttl=14400
Response
Returns Success as the status of the response if the record is modified successfully.
In case of any error, an error key with error description (as value) will be returned.
Did you find this article helpful?