Delete Custom Zone Mappings
On this page
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 Administration 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 Get Started with the Atlas Administration API.
https://cloud.mongodb.com/api/atlas/v1.0
Removes all custom zone mappings from the specified Global Cluster.
Syntax
DELETE /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/globalWrites/customZoneMapping
Request Path Parameters
Path Element | Required/Optional | Description |
|---|---|---|
GROUP-ID | Required. | The unique identifier for the project that contains
the Global Cluster. |
CLUSTER-NAME | Required. | The name of the Global Cluster. |
Request Query Parameters
This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These 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, the response body includes:
| false |
Request Body Parameters
This endpoint does not use HTTP request body parameters.
HTTP Response Elements
Name | Type | Description |
|---|---|---|
customZoneMapping | document | An empty document. |
managedNamespaces | array of documents | Each document specifies a managed namespace for a Global Cluster managed by Atlas. The array is empty
if no managed namespaces are specified for the Global Cluster.
For more information, see Global Clusters. |
managedNamespaces[n].collection | string | The name of the collection associated with the managed namespace. |
managedNamespaces[n].customShardKey | string | The 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].db | string | The name of the database containing the collection. |
Example
Request
curl -X DELETE -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -H "Content-Type: application/json" \ "https://cloud.mongodb.com/api/atlas/v1.0/groups/6c391af480eef519ea5ceeb1/clusters/GlobalCluster1/globalWrites/customZoneMapping?pretty=true"
Response
{ "customZoneMapping" : { }, "managedNamespaces" : [ { "collection" : "publishers", "customShardKey" : "city", "db" : "myData" } ] }