Add Custom Zone Mappings

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.

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.

Add an entry to the list of custom zone mappings for the specified Global Cluster.

POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/globalWrites/customZoneMapping
Path ElementRequired/OptionalDescription
GROUP-IDRequired.The unique identifier for the project that contains the Global Cluster.
CLUSTER-NAMERequired.The name of the Global Cluster.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

The request body for this endpoint requires a document with at least one custom zone mapping, as shown in the following example:

{ "customZoneMappings": [ { "location": <code>, "zone": <zone>}, ... ] }
customZoneMappingsdocument arrayEach document in the array maps one ISO location code to a zone in your Global Cluster.
customZoneMappings[n].locationstringRequired The ISO location code to which you want to map a zone in your Global Cluster. You can find a list of all supported location codes here.
customZoneMappings[n].zonestringRequired The name of the zone in your Global Cluster that you want to map to location.
customZoneMappingdocumentA comma-separated list of all custom zone mappings defined for the Global Cluster. By default, Atlas maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings.
managedNamespacesarray of documentsEach document specifies a namespace for a Global Cluster managed by Atlas. For more information, see Global Clusters.
managedNamespaces[n].collectionstringThe name of the collection associated with the managed namespace.
managedNamespaces[n].customShardKeystringThe custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.
managedNamespaces[n].dbstringThe name of the database containing the collection.
curl -X POST -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -H "Content-Type: application/json" \
"" \
--data '{
"customZoneMappings" : [{
"zone": "Zone 1"
"customZoneMapping" : {
"CA" : "5b50bf4180eef547653df4d0"
"managedNamespaces" : [ {
"collection" : "publishers",
"customShardKey" : "city",
"db" : "myData"
} ]
Give Feedback