DIdigicert
soa

Returns the details of a specific SOA record.

This endpoint returns the details of a specific SOA record, enabling users to review and manage its configuration.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns a 404 error code with a clear description when requests fail.</br>- Targeted data retrieval: Employs the soaId parameter to return the specified SOA record's details, ensuring accuracy and relevance in the response.

get/soa/{soaId}

Request

Path parameters

soaIdinteger required

Filters data by the SOA record’s unique identifier.

Response

SOA record returned successfully.

idinteger
namestring
primaryNameserverstring
emailstring
ttlinteger
startingSerialstring
refreshinteger
retryinteger
expirestring
negativeCacheinteger
createdTsstring
modifiedTsstring
isDefaultboolean

Example response

{
  "id": 1,
  "name": "mySoa",
  "primaryNameserver": "ns10.organizationdns.com",
  "email": "user@organization.com",
  "ttl": 86400,
  "startingSerial": "2024061202",
  "refresh": 120,
  "retry": 3600,
  "expire": "1209600",
  "negativeCache": 180,
  "createdTs": "2024-02-01 14:02:58.325993",
  "modifiedTs": "2024-02-01 14:02:58.325993",
  "domains": [
    {
      "id": 1,
      "name": "example.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.