records - primary - CNAME

Creates a CNAME record for a specific primary domain.

This endpoint creates a CNAME record for a specific primary domain, enabling users to associate the domain with an IP address.</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 400 error code with a clear description when requests fail.</br>- Seamless record creation: Facilitates the creation of a CNAME record in-line with the appropriate schema, ensuring smooth and efficient organization.</br>- Targeted data addition: Leverages the domainId parameter in the URL path to add a new CNAME record to the specified domain, ensuring accurate and focused modifications for effective domain management.

post/domains/primary/{domainId}/records/CNAME

Request

Path parameters

domainIdinteger required

Filters data by the domain's unique identifier.

Request body

typestring
namestring
aliasstring
ttlinteger
enabledboolean
createdTsstring date-time
modifiedTsstring date-time
systemFlagboolean

Example request

{
  "type": "CNAME",
  "name": "test",
  "alias": "cname.example.com.",
  "ttl": 1800,
  "enabled": true,
  "createdTs": "2026-01-01T01:00:00.123456Z",
  "modifiedTs": "2026-01-01T01:00:00.123456Z",
  "region": {
    "gtdLocationId": 1,
    "regionName": "NA_WEST",
    "regionLabel": "NA West"
  }
}

Response

CNAME record created successfully.

idinteger
typestring
namestring
aliasstring
ttlinteger
enabledboolean
createdTsstring date-time
modifiedTsstring date-time
systemFlagboolean

Example response

{
  "id": 1,
  "type": "CNAME",
  "name": "test",
  "alias": "cname.example.com.",
  "ttl": 1800,
  "enabled": true,
  "createdTs": "2026-01-01T01:00:00.123456Z",
  "modifiedTs": "2026-01-01T01:00:00.123456Z",
  "region": {
    "gtdLocationId": 1,
    "regionName": "NA_WEST",
    "regionLabel": "NA West"
  }
}

Changes

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