POST

/domainnames

http://apigateway.{region}.amazonaws.com/domainnames

Creates a new domain name.

Access Token Required: API Key

Body Params

tagsobject

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.

domainNamestringrequired

The name of the DomainName resource.

certificateArnstring

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

securityPolicystring

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.

certificateBodystring

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

certificateNamestring

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

certificateChainstring

[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

certificatePrivateKeystring

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

endpointConfigurationobject

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

regionalCertificateArnstring

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

mutualTlsAuthenticationobject

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

regionalCertificateNamestring

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

ownershipVerificationCertificateArnstring

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/domainnames' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}