Skip to main content

API Validation Messaging

Updated

This document provides API validation messages for DNS and infrastructure components, supplementing endpoint testing. Items are organized by function to facilitate easier reference and navigation.

Category Associated items
Configuration App validation
Date validation
DNS resources Domain validation
Field validation
GTD validation
Nameserver set validation
Nameserver validation
Record validation
TSIG validation
Identity and access Account validation
User validation
Networking IP address validation
IP set validation
Resource organization Resource group validation

Configuration validation messaging

This document covers app-specific and date-related rules, helping enforce correct input formats and catch configuration errors early.

App validation

 

Validation Messaging
MISSING_APPLICATION_IDENTIFIER_FOR_ENTITLEMENT An application identifier is required to assign and update entitlements.
WRONG_DESTINATION_APP_ID The destination application ID, '%s', is incorrect or not recognized.

Date validation

 

Validation Messaging
INVALID_DATE_RANGE The selected end date occurs before the domain was created or is set in the future. Please specify an end date between the domain's creation date and today.
INVALID_DATE_RANGE_ACCOUNT The selected end date occurs before the account was created or is set in the future. Please specify an end date between the account's creation date and today.
INVALID_FUTURE_DATE Future dates are not supported. Only data from the current year up to today is available.

DNS resource validation messaging

This document lists messages for domains, fields, and records, helping identify misconfigurations that could affect resolution, availability, or automation.

Select a section to view its specific validation and messaging.

Domain validation

 

Validation Messaging
DOMAIN_IDS_CANNOT_BE_EMPTY Domain IDs are required and cannot be empty.
DOMAIN_NAME_INVALID '%s' is an invalid domain name.
DOMAIN_NOT_FOUND_FAILURE_DESCRIPTION The domain, '%s', was not found.
DOMAIN_WITH_NAME_ALREADY_EXISTS A domain with the name '%s' already exists.
DOMAINS_NOT_FOUND The domains, '%s' and '%s', were not found.
MAX_DOMAINS_PER_CREATE A maximum of 10 domains can be created at once.
SECONDARY_DOMAIN_NOT_FOUND_FAILURE_DESCRIPTION The secondary domain, '%s', was not found.

Field validation

 

Validation Messaging
BETWEEN_ZERO_AND_UNSIGNED_16_BIT The '%s' field must contain a value between 0 and 65,535.
BETWEEN_ZERO_AND_UNSIGNED_32_BIT The '%s' field must contain a value between 0 and 4,294,967,295.
BULK_DELETE_IDS_REQUIRED A list of IDs is required in the '%s' field for bulk deletion.
CANNOT_BE_EMPTY The '%s' field cannot be empty.
CANNOT_CONTAIN_DUPLICATES The '%s' field cannot contain duplicate values.
FIELD_IS_INVALID The '%s' field is invalid.
FIELD_NOT_ALPHA The '%s' field must contain only alphabetic characters.
GREATER_OR_EQUAL_ZERO The '%s' field must contain a value that is greater than or equal to zero.
GREATER_THAN_ZERO The '%s' field must contain a value that is greater than zero.
INVALID_RECORD_TYPE The '%s' field contains an invalid record type.
INVALID_RESOURCE_NAME '%s' is an invalid resource name.
INVALID_SYNTAX_TYPE The '%s' field contains an invalid TXT syntax type.
IS_REQUIRED The '%s' field is required and cannot be left blank.
MAXIMUM_LENGTH The '%s' field cannot exceed %s characters.
RECORD_TYPES_DONT_MATCH The request path parameter type, '%s', does not match the request body type of '%s'.

GTD validation

 

Validation Messaging
DEFAULT_GTD_NOT_FOUND The default GTD region, '%s', was not found.
GTD_NOT_ENABLED GTD is not enabled for this account.
GTD_NOT_ENABLED_ON_DOMAIN The domain, '%s', is not GTD-enabled.
GTD_REGION_DOES_NOT_MATCH_ID The GTD region name, '%s', and GTD location ID, '%s', do not match.
GTD_REGION_INVALID '%s' is an invalid GTD region.
GTD_REGION_NOT_FOUND The GTD region, '%s', was not found.
GTD_REGION_UPDATE_NOT_ALLOWED The GTD region, '%s', cannot be updated.

Nameserver set validation

 

Validation Messaging
NAMESERVER_SET_ASSIGNED_TO_DOMAIN_CANNOT_BE_DELETED The nameserver set, '%s', is assigned to one or more domains and so cannot be deleted.
NAMESERVER_SET_DEFAULT_NOT_FOUND_FOR_ACCOUNT The default nameserver set of the account, '%s', was not found.
NAMESERVER_SET_MAXIMUM_NAMESERVERS_REACHED The nameserver set, '%s', has a maximum capacity of %s nameservers.
NAMESERVER_SET_NAME_CANNOT_BE_EMPTY Nameserver set names are required and cannot be empty.
NAMESERVER_SET_SYSTEM_NAME_OR_NAMESERVERS_NOT_ALLOWED_UPDATE Neither the name nor nameservers of the system nameserver set, '%s', can be updated.
NAMESERVER_SET_SYSTEM_NOT_ALLOWED_DELETE The system nameserver set, '%s', cannot be deleted.
NAMESERVER_SET_SYSTEM_NOT_ALLOWED_UPDATE The system nameserver set, '%s', cannot be updated.
NAMESERVER_SET_SYSTEM_NOT_FOUND The system nameserver set, '%s', was not found.
NAMESERVER_SET_TOO_MANY_NEW_NAMESERVERS The nameserver set, '%s', has a maximum capacity of %s nameservers.
NAMESERVER_SET_WITH_ID_NOT_FOUND The nameserver set, '%s', was not found.
NAMESERVER_SET_WITH_ID_NOT_FOUND_FOR_ACCOUNT The account, '%s', does not contain a nameserver set with the ID '%s'.
NAMESERVER_SET_WITH_IDS_NOT_FOUND The nameserver sets, '%s' and '%s', were not found.
NAMESERVER_SET_WITH_NAME_ALREADY_EXISTS A nameserver set with the name '%s' already exists.
NO_NAMESERVER_SET_ASSOCIATED_WITH_DOMAIN The domain, '%s', is not associated with any nameserver sets.

Nameserver validation

 

Validation Messaging
NAMESERVERS_ID_FQDN Either a nameserver ID or FQDN must be provided.
NAMESERVERS_MIN_MAX Nameserver sets must contain %s - %s nameservers.
NAMESERVER_WITH_ID_DOES_NOT_EXIST The nameserver, '%s', does not exist.

Record validation

 

Table 1. General validation

Validation Messaging
COMBINED_RECORD_MAX_COUNT_EXCEEDED The maximum number of combined records for this endpoint is %s.
DUPLICATE_RECORD_OF_TYPE_EXISTS A/an '%s' record named '%s' already exists.
NO_DUPLICATE_RECORD_ALLOWED Duplicate records are not allowed.
RECORD_NAME_CANNOT_BE_EMPTY Record names are required and cannot be empty.
RECORD_NAME_CANNOT_CONTAIN Record names cannot contain '%s'.
RECORD_NAME_CANNOT_CONTAIN_SPECIAL_CHARS_EXCEPT Record names cannot contain special characters. Only '%s' is/are allowed.
RECORD_NAME_CANNOT_END_WITH Record names cannot end with '%s'.
RECORD_NAME_CANNOT_EQUAL The record's name cannot be '%s'.
RECORD_NAME_CANNOT_START_OR_END_WITH Record names can neither start nor end with '%s'.
RECORD_NAME_CANNOT_START_WITH Record names cannot start with '%s'.
RECORD_NOT_FOUND_BY_ID The record, '%s', was not found.
STANDARD_RECORD_FAILOVER_MODE_NOT_FOUND The record, '%s', is missing a failover mode configuration.
SYSTEM_RECORD_BULK_DELETE_NOT_ALLOWED '%s' is a system record. System records cannot be deleted in bulk.
SYSTEM_RECORD_DELETE_NOT_ALLOWED System records cannot be deleted.
SYSTEM_RECORD_UPDATE_NOT_ALLOWED The system record, '%s', cannot be updated.
SYSTEM_RECORDS_NOT_ALLOWED Setting 'systemFlag' is not allowed.


Table 2. AAAA record validation

Validation Messaging
MISSING_TARGET_A_AAAA The value, '%s', is missing a target A/AAAA record. To resolve this, create an A/AAAA record named '%s'.


Table 3. CAA record validation

Validation Messaging
CAA_ALL_CERT_AUTHORITIES_BLOCKED This configuration blocks all CAs from issuing any certificates. Reporting via IODEF remains enabled.
CAA_IODEF_MUST_BE_CUSTOM The IODEF tag in CAA records must use a custom Provider value.
CAA_ISSUER_CRITICAL_IN_RANGE The 'issuerCritical' field must contain a value of 0 or 1.
CAA_NO_PROVIDER_ISSUANCE_ONLY This configuration blocks wildcard certificate issuance by CAs but allows standard certificate issuance. Reporting via IODEF remains enabled.
CAA_NO_PROVIDER_MULTI_VALUES CAA records with multiple values cannot be used without a specified provider.
CAA_NO_PROVIDER_VALUE_FOR_EMPTY A value is required when no provider is specified for a CAA record.
CAA_NO_PROVIDER_WILDCARD_ISSUANCE_ONLY This configuration blocks certificate issuance by CAs but allows wildcard certificates. Reporting via IODEF remains enabled.
CAA_PROVIDER_DOES_NOT_MATCH_VALUE The specified provider, '%s', does not match the given value, '%s', in the CAA record.
CAA_VALUE_CONTAINS_INVALID_ADDITIONAL_TAG '%s' contains an invalid additional tag.
CAA_VALUE_CONTAINS_INVALID_ADDITIONAL_VALUE '%s' contains an invalid additional value.
CAA_VALUE_CONTAINS_INVALID_PARAMETER '%s' contains an invalid parameter.
CAA_VALUE_INVALID '%s' is an invalid CAA value.
CAA_VALUE_NOT_A_VALID_HOSTNAME '%s' is an invalid hostname.
CAA_VALUE_NOT_A_VALID_URI '%s' is an invalid URI.
CAA_VALUE_REJECT_USE_NO_PROVIDER The value, ';', is only valid when 'No Provider' is selected.
INVALID_ISSUE_TYPE '%s' is an invalid issue type. Issue types can only be 'issue', 'issuewild', 'iodef', 'issuemail', or 'issuevmc'.
MAX_CAA_VALUES A maximum of 10 CAA values is allowed per record.


Table 4. CNAME record validation

Validation Messaging
CNAME_ALIAS_CANNOT_CONTAIN The CNAME alias, '%s', cannot contain '%s'.
CNAME_ALIAS_CANNOT_CONTAIN_SPECIAL_CHARS_EXCEPT The CNAME alias, '%s', cannot contain special characters. Only '%s' is/are allowed.
CNAME_ALIAS_CANNOT_HAVE_TRAILING_DOTS_AND_NUMBERS The CNAME alias, '%s', cannot have trailing dots or numbers.
CNAME_ALIAS_CANNOT_START_WITH The CNAME alias, '%s', cannot start with '%s'.
CNAME_ALIAS_IS_INVALID '%s' is an invalid CNAME alias.
CNAME_CHAINING_NOT_RECOMMENDED The CNAME record, '%s', points to another CNAME, '%s'. CNAME chaining is discouraged due to possible performance and reliability issues.
CNAME_LOOPING As per RFC standard 1034, CNAME loops are not allowed. The record name '%s' and alias '%s' are identical.
VALUE_POINTS_TO_CNAME_ALIAS As per RFC-2181, '%s' cannot match an existing CNAME record name.


Table 5. MX record validation

Validation Messaging
MAX_MX_VALUES A maximum of 15 MX values is allowed per record.
MX_NOT_AVAILABLE_MULTI_VALUES Multiple MX values are not allowed when using a 'No service' value of '.'.
MX_NOT_AVAILABLE_PRIORITY The value's priority must be 0 when specifying a 'No service' value of '.'.
MX_SERVER_VALUES_ARE_REQUIRED MX server values are required.


Table 6. NS record validation

Validation Messaging
MAX_NS_VALUES A maximum of 10 NS values is allowed per record.
NO_DUPLICATE_HOSTNAMES Duplicate hostnames are not allowed.
ROOT_NS_MUST_BE_IN_DEFAULT The root NS record must be placed in the default GTD region.


Table 7. PTR record validation

Validation Messaging
MAX_PTR_VALUES A maximum of 10 PTR values is allowed per record.


Table 8. SOA record validation

Validation Messaging
DEFAULT_NAME_NOT_ALLOWED_UPDATE The default SOA record name, '%s', cannot be updated.
DEFAULT_SOA_NOT_ALLOWED_CREATED The SOA record, '%s', cannot be set as the default because a default record ('%d') already exists. To make changes, please update the existing default.
DEFAULT_SOA_NOT_ALLOWED_DELETED The default SOA record, '%s', cannot be deleted.
DEFAULT_SOA_NOT_FOUND_FOR_ACCOUNT The default SOA record of the account, '%s', was not found.
SOA_ID_NOT_ALLOWED_UPDATE The SOA record ID, '%s', cannot be updated because it does not match the path parameter ID of '%d'.
SOA_IN_USE_BY_DOMAIN The SOA record, '%s', is currently in use.
SOA_NOT_FOUND The SOA record, '%s', was not found.
SOA_RECORD_NAME_INVALID '%s' is an invalid SOA record name.
SOA_SERIAL_NOT_ALLOWED_UPDATE The field, 'startingSerial', cannot be updated.
SOAS_NOT_FOUND The SOA records, '%s' and '%s', were not found.


Table 9. SRV record validation

Validation Messaging
MAX_SRV_VALUES A maximum of 15 SRV values is allowed per record.
SRV_VALUE_SHOULD_START_WITH The SRV value, '%s', must start with '%s'.
SRV_VALUES_ARE_REQUIRED SRV values are required.


Table 10. TXT record validation

Validation Messaging
INVALID_SYNTAX '%s' is an invalid syntax type.
MAX_TXT_VALUES A maximum of 15 TXT values is allowed per record.
TXT_VALUE_LENGTH_VIOLATION The TXT record, '%s', exceeds the 4096 character limit.
UNKNOWN_TAG The TXT value, '%s', contains an unknown tag.


TSIG validation

 

Validation Messaging
TSIG_KEY_NAME_INVALID '%s' is an invalid TSIG key name.
TSIG_KEY_NOT_FOUND The TSIG key, '%s', was not found.

Identity and access validation messaging

This document outlines constraints on user details, account membership, and related events to ensure consistent identity management and prevent common configuration mistakes.

Account validation

 

Validation Messaging
ACCOUNT_CREATE_EVENT_MISSING_APPLICATION The account creation event, '%s', must be associated with an application.
ACCOUNT_CREATE_EVENT_NO_USERS The account creation event, '%s', must include at least one user.
ACCOUNT_NOT_FOUND_ONE_LOGIN The account, '%s', was not found.
ACCOUNT_STATUS_EVENT_ACCOUNT_NOT_FOUND '%s', referenced in the account status event, was not found.
DUPLICATE_ACCOUNT_WITH_NAME An account with the name '%s' already exists.
DUPLICATE_ACCOUNT_WITH_ONE_LOGIN An account with the ID '%s' already exists.

User validation

 

Validation Messaging
USER_EVENT_MISSING_APPLICATION The user event, '%s', must be associated with an application.
USER_EXISTS_WITH_USERNAME_FOR_ACCOUNT A user with the username '%s' already exists for this account.
USER_FOUND_FOR_ACCOUNT_ID The user, '%s', of the account, '%s', was found.
USER_MISSING_APPLICATION The user, '%s', must be associated with an application.
USER_STATUS_EVENT_ACCOUNT_NOT_FOUND '%s', referenced in the user status event, was not found.

Networking validation messaging

This document focuses on IP addresses and IP sets, maintaining network accuracy, avoiding conflicts, and ensuring resource consistency.

IP address validation

 

Validation Messaging
INVALID_IP_ADDRESS '%s' is an invalid IP address.
INVALID_IPV4 '%s' is an invalid IPv4 address.
INVALID_IPV6 '%s' is an invalid IPv6 address.
INVALID_SUBNET '%s' is an invalid subnet.
IPV4_REQUIRED An IPv4 address is required.
IPV6_REQUIRED An IPv6 address is required.
MAX_IPS_PER_RECORD A maximum of 25 IP addresses is allowed per record.
NO_DUPLICATE_IP_VALUES_ALLOWED Duplicate IP addresses are not allowed.

IP set validation

 

Validation Messaging
IPSET_WITH_ID_DOES_NOT_EXIST An IP set with the ID '%s' does not exist.
PRIMARY_IP_SET_WITH_NAME_ALREADY_EXISTS A primary IP set with the name '%s' already exists.
SECONDARY_IP_SET_NOT_CONFIGURED_FAILURE_DESCRIPTION Secondary IP sets are not configured. Please configure them before proceeding.
SECONDARY_IP_SET_WITH_NAME_ALREADY_EXISTS A secondary IP set with the name '%s' already exists.

Resource organization validation messaging

This document covers rules for naming, removals, and group relationships, enabling effective management of dependencies and consistent resource organization.

Resource group validation

 

Validation Messaging
DUPLICATE_RESOURCE_GROUP A resource group with the name '%s' already exists.
EMPTY_RESOURCE_LIST No resources are available for removal.
FAILED_TO_REMOVE_RESOURCE_GROUP_ASSOCIATIONS The resource group associations of the domain, '%s', were not removed.
NO_CHANGE_DETECTED No changes detected. Please modify at least one field to update the resource group.
RESOURCE_GROUP_NAME_REQUIRED Resource group names are required and cannot be empty.