domains - primary

Returns the details of a specific primary domain.

This endpoint returns the details of a specific primary domain, helping users manage and configure it effectively.</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 400 and 404 error codes with clear descriptions when requests fail.</br>- Targeted data retrieval: Employs the domainId parameter to return the specified domain's details, ensuring accuracy and relevance in the response.

get/domains/primary/{domainId}

Request

Path parameters

domainIdinteger required

Filters data by the domain's unique identifier.

Response

Primary domain returned successfully.

idinteger
namestring
typestring
noOfRecordsnumber
dnssecboolean
gtdboolean
createdAtstring
modifiedAtstring
statusinteger

Example response

[
  {
    "id": 1,
    "name": "example.com",
    "type": "primary",
    "noOfRecords": 30,
    "dnssec": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "modifiedAt": "2024-01-01T00:00:00Z",
    "queries": {
      "total": 200,
      "refused": 50,
      "servfail": 5,
      "notimpl": 5,
      "responsecount": 60,
      "noerror": 50,
      "nxdomain": 20,
      "formerr": 10
    },
    "resourceGroups": [
      {
        "id": 1,
        "name": "Resource Group 1"
      }
    ],
    "soa": {
      "id": 1,
      "name": "SOA"
    },
    "tsigKeyConfig": [
      {
        "ipset": {
          "ipSetId": 1
        },
        "tsigKey": {
          "id": 1
        }
      }
    ],
    "nameserverSet": {
      "id": 1,
      "nameservers": {
        "id": 1,
        "fqdn": "ns1.example.com",
        "ipv4": "1.1.1.1",
        "ipv6": "fc00:db20:35b:7399::5",
        "vanityNameserverFQDN": "ns1.example.com",
        "createdTs": "2024-01-01T00:00:00Z",
        "modifiedTs": "2024-01-01T00:00:00Z"
      }
    },
    "valiMail": {
      "enabled": true,
      "policy": "NONE",
      "additionalRua": "mailto:test@test.com"
    }
  }
]

Changes

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