domains - primary

Updates a specific primary domain.

This endpoint updates a specific primary domain, allowing users to quickly make changes without impacting other 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 error handling: Returns a 404 error code with a clear description when requests fail.</br>- Reliable updates: Facilitates the modification of a specific primary domain, ensuring accurate and up-to-date information across the system.</br>- Targeted data retrieval: Leverages the domainId parameter in the URL path to update the specified domain, ensuring accurate and focused modifications.

put/domains/primary/{domainId}

Request

Path parameters

domainIdinteger required

Filters data by the domain's unique identifier.

Request body

namestring
soaIdinteger
gtdboolean
resourceGroupsinteger[]
nameserverSetIdinteger

Example request

{
  "name": "example.com",
  "soaId": 1,
  "gtd": true,
  "tsigKeyConfig": [
    {
      "ipSetId": 1,
      "tsigKeyId": 1
    }
  ],
  "nameserverSetId": 1,
  "valiMail": {
    "enabled": true,
    "policy": "NONE",
    "additionalRua": "mailto:test@test.com"
  }
}

Response

Primary domain updated successfully.

idinteger
namestring
typestring
soaIdinteger
nameserverSetIdinteger
gtdboolean
createdTsstring
modifiedTsstring
resourceGroupsinteger[]
valimailboolean

Example response

{
  "id": 1,
  "name": "example.com",
  "type": "PRIMARY",
  "soaId": 1,
  "nameserverSetId": 1,
  "gtd": true,
  "createdTs": "2024-10-03T22:00:00.000+00:00",
  "modifiedTs": "2024-10-03T22:00:00.000+00:00",
  "tsigKeyConfig": [
    {
      "ipSetId": 1,
      "tsigKeyId": 1
    }
  ]
}

Changes

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