Get Custom DNS Configuration for Atlas Clusters on AWS¶
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
.
Retrieve 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.
Required Roles¶
You can successfully call this endpoint with any assigned role.
Request¶
https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{GROUP-ID}/awsCustomDNS
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID | Required | Unique identifier for the project. |
Request Query Parameters¶
Name | Type | Description | Default | ||||
---|---|---|---|---|---|---|---|
envelope | boolean | 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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Field | Type | Description |
---|---|---|
enabled | boolean | Indicates whether the project's clusters deployed to AWS use custom DNS. If |
Example Request¶
curl -X GET -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/awsCustomDNS"
Example Response¶
Response Header¶
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 200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
{ "enabled": true }