atlas api globalClusters deleteAllCustomZoneMappings
On this page
experimental: Removes all custom zone mappings for the specified global cluster.
A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deleteAllCustomZoneMappings'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings
Syntax
atlas api globalClusters deleteAllCustomZoneMappings [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | human-readable label that identifies this cluster |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for deleteAllCustomZoneMappings | |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--version | string | false | api version to use when calling the api call [options: "2023-01-01", "2023-02-01", "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |