Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api monitoringAndLogs listMetricTypes

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Returns all Atlas Search metric types available for one process in the specified project.

You must have the Project Read Only or higher role to view the Atlas Search metric types. This command is invoking the endpoint with OperationID: 'listMetricTypes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes

Command Syntax
atlas api monitoringAndLogs listMetricTypes [options]
Name
Type
Required
Description

--envelope

false

flag that indicates whether Application wraps the response in an envelope JSON object

--groupId

string

true

unique 24-hexadecimal digit string that identifies your project

-h, --help

false

help for listMetricTypes

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--processId

string

true

combination of hostname and IANA port that serves the MongoDB process

--version

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Name
Type
Required
Description

-P, --profile

string

false

Back

listIndexMetrics