atlas organizations apiKeys accessLists delete
Remove the specified IP access list entry from your API Key.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To use this command, you must authenticate with a user account or an API key with the Read Write role.
Syntax
atlas organizations apiKeys accessLists delete <entry> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
entry | string | true | IP or CIDR address that you want to remove from the access list. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--apiKey | string | false | Unique 24-digit ID that identifies your API key. |
--force | false | Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | |
-h, --help | false | help for delete | |
--orgId | string | false | Organization ID to use. This option overrides the settings in the configuration file or environment variable. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Access list entry '<Name>' deleted
Examples
# Remove the IP address 192.0.2.0 from the access list for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys accessLists delete 192.0.2.0 --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345