Docs Menu

Docs HomeAtlas App Services

appservices login

On this page

  • Syntax
  • Options
  • Inherited Options

Log the CLI into App Services using a MongoDB Cloud API Key

Begins an authenticated session with App Services. To get a MongoDB Cloud API Key, open your app in the App Services UI. Navigate to "Deployment" in the left navigation menu, and select the "Export App" tab. From there, create a programmatic API Key to authenticate your appservices session.

Command Syntax
appservices login [options]
Name
Type
Required
Description
--api-key
string
false
Specify the public portion of your Atlas programmatic API Key
--private-api-key
string
false
Specify the private portion of your Atlas programmatic API Key
--browser
false
Direct browser to project access page to create a new API Key for logging into a project (Note: Can not be used in combination with login credentials)
-h, --help
false
help for login
Name
Type
Required
Description
--profile
string
false
Specify your profile (Default value: "default")
--telemetry
string
false
Enable/Disable CLI usage tracking for your current profile (Default value: "on"; Allowed values: "on", "off")
-o, --output-target
string
false
Write CLI output to the specified filepath
-f, --output-format
string
false
Set the CLI output format (Default value: <blank>; Allowed values: <blank>, "json")
--disable-colors
false
Disable all CLI output styling (e.g. colors, font styles, etc.)
-y, --yes
false
Automatically proceed through CLI commands by agreeing to any required user prompts
←  appservices function runappservices logout →