soa

Lists all available SOA records.

This endpoint lists all available SOA records, helping users manage and configure the authoritative DNS information for their domains.</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 data retrieval: Returns a comprehensive list of all SOA records, providing a complete and accurate overview for seamless management and analysis.</br>- Comprehensive error handling: Returns a 401 error code with a clear description when requests fail.</br>- Efficient sorting: The sortBy parameter enables users to organize responses by various attributes, offering flexibility in result management.

get/soa

Request

Query parameters

sortBy'createdTsAsc' | 'createdTsDesc' | 'createdAtAsc' | 'createdAtDesc' | 'updatedAtAsc' | 'updatedAtDesc' | 'modifiedTsAsc' | 'modifiedTsDesc' | 'ttlAsc' | 'ttlDesc' | 'nameAsc' | 'nameDesc' | 'primaryNameserverAsc' | 'primaryNameserverDesc' | 'emailAsc' | 'emailDesc' | 'startingSerialAsc' | 'startingSerialDesc' | 'serialAsc' | 'serialDesc' | 'refreshAsc' | 'refreshDesc' | 'retryAsc' | 'retryDesc' | 'expireAsc' | 'expireDesc' | 'negativeCacheAsc' | 'negativeCacheDesc'

Specifies the sorting order of results.

Response

SOA records listed successfully.

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.