atlas api programmaticApiKeys
Public Preview: please provide feedback: Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API.
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.
MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for programmaticApiKeys |
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. |
Related Commands
atlas api programmaticApiKeys addProjectApiKey - Public Preview: please provide feedback: Assigns the specified organization API key to the specified project.
atlas api programmaticApiKeys createApiKey - Public Preview: please provide feedback: Creates one API key for the specified organization.
atlas api programmaticApiKeys createApiKeyAccessList - Public Preview: please provide feedback: Creates the access list entries for the specified organization API key.
atlas api programmaticApiKeys createProjectApiKey - Public Preview: please provide feedback: Creates and assigns the specified organization API key to the specified project.
atlas api programmaticApiKeys deleteApiKey - Public Preview: please provide feedback: Removes one organization API key from the specified organization.
atlas api programmaticApiKeys deleteApiKeyAccessListEntry - Public Preview: please provide feedback: Removes the specified access list entry from the specified organization API key.
atlas api programmaticApiKeys getApiKey - Public Preview: please provide feedback: Returns one organization API key.
atlas api programmaticApiKeys getApiKeyAccessList - Public Preview: please provide feedback: Returns one access list entry for the specified organization API key.
atlas api programmaticApiKeys listApiKeyAccessListsEntries - Public Preview: please provide feedback: Returns all access list entries that you configured for the specified organization API key.
atlas api programmaticApiKeys listApiKeys - Public Preview: please provide feedback: Returns all organization API keys for the specified organization.
atlas api programmaticApiKeys listProjectApiKeys - Public Preview: please provide feedback: Returns all organization API keys that you assigned to the specified project.
atlas api programmaticApiKeys removeProjectApiKey - Public Preview: please provide feedback: Removes one organization API key from the specified project.
atlas api programmaticApiKeys updateApiKey - Public Preview: please provide feedback: Updates one organization API key in the specified organization.
atlas api programmaticApiKeys updateApiKeyRoles - Public Preview: please provide feedback: Updates the roles of the organization API key that you specify for the project that you specify.