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

atlas api

On this page

Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>: Access all features of the Atlas Administration API by using the Atlas CLI with the syntax: 'atlas api <tag> <operationId>'.

This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI.

For more information on - Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/ - Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access

This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI.

Syntax

Command Syntax
atlas api <tag> <operationId> [options]

Important

Both <tag> and <operationId> must be in camelCase.

Arguments

Name
Type
Required
Description

<tag>

string

true

The category of Atlas Administration API operations in camelCase. To find and format the tag, check the API documentation URL for the endpoint. It appears after #tag/, but you need to change to camelCase. For the Atlas API documentation, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/.

For example, in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs, the tag is Monitoring-and-Logs. In camelCase, it's monitoringAndLogs.

<operationId>

string

true

The identifier of the Atlas Administration API endpoint in camelCase. To find the operationId, check the API documentation URL for the endpoint. It appears after operation/. For the Atlas API documentation, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/.

For example, in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters, the operationId is listClusters.

Subcommand options

Pass in the path and query parameters for the Atlas Administration API endpoint as flags. For example, if the endpoint is /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}, the Atlas CLI command is:

atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>

Note

You usually don't need to specify --orgId and --projectId as they are sourced from your profile. Specify them only if they are not set in your profile.

If applicable to the endpoint, pass in the request body using the --file option or standard input (stdin). For example:

atlas api clusters create --file cluster-config.json

In addition, the following options are available for all Atlas Administration API endpoints.

Name
Type
Required
Description

--api-version

string

false

Specify the version of the Atlas Administration API for the command. Defaults to the latest API version or the value you've configured for api_version in your profile.

--out

string

false

Output format. The default is json, but the supported formats can vary by endpoint:

  • Most endpoints output json. When json is supported, you can also use a Go template.

  • Some endpoints support json and csv, allowing you to use json, csv, or a Go template.

  • Certain endpoints output binary data (for example, logs in gzip format), requiring the --out option.

To determine the supported formats for an endpoint:

-o, --out-file

string

false

File path to save the output. By default, the result is displayed in the terminal.

--file

string

false

File path to the request body content, if required by the operation. Alternatively, provide input through standard input (stdin).

-h, --help

boolean

false

Help for the current command.

Options

Name
Type
Required
Description

-h, --help

false

help for api

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

Back

unacknowledge

Next

accessTracking