Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
projects
/
apiKeys

atlas projects apiKeys create

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples

Create an organization API key and assign it to your project.

MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys.

To use this command, you must authenticate with a user account or an API key with the Project User Admin role.

Syntax

Command Syntax
atlas projects apiKeys create [options]

Options

Name
Type
Required
Description
--desc
string
true
Description of the API key.
-h, --help
false
help for create
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--role
strings
true
Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/.

Inherited Options

Name
Type
Required
Description
-P, --profile
string
false

Output

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

API Key '<Id>' created.
Public API Key <PublicKey>
Private API Key <PrivateKey>

Examples

# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json

Back

assign

Next

delete