Navigation

Update Custom DNS Configuration for Atlas Clusters on AWS

Info With Circle IconCreated with Sketch.Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Update the custom DNS configuration of an Atlas project's clusters deployed to AWS .

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

You must have one of the following roles to successfully call this resource:

https://cloud.mongodb.com/api/atlas/v1.0

PATCH /groups/{GROUP-ID}/awsCustomDNS
ParameterRequired/OptionalDescription
GROUP-IDRequiredUnique identifier for the project.
NameTypeDescriptionDefault
envelopeboolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, response body includes:

statusHTTP response code
envelopeThe expected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

false
NameTypeNecessityDescription
enabledbooleanRequired

Indicates whether the project's clusters deployed to AWS use custom DNS.

If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .

FieldTypeDescription
enabledboolean

Indicates whether the project's clusters deployed to AWS use custom DNS.

If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/awsCustomDNS" \
--data '
{
"enabled": true
}'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 202 Accepted
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
{
"enabled": true
}
Give Feedback