mongocli atlas events list¶
The events list
command retrieves information about events for a
given Atlas project or organization. You must specify either a project or
an organization in the command.
Syntax¶
mongocli atlas events list|ls [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ] [ --orgId <organization-ID> ] [ --limit <items-per-page> ] [ --maxDate <max-date> ] [ --minDate <min-date> ] [ --page <page-num> ]
Note
Use -h
or --help
to view the command-line help for
this command.
Options¶
Specify either a project with --projectId
or an organization with
--orgId
.
Option | Type | Description | Required? |
---|---|---|---|
--limit | integer | Number of items per page, up to a maximum of 500. Defaults to 100 if not
specified. | no |
--maxDate | string | Return events whose created date is less than or equal to it. | no |
--minDate | string | Return events whose created date is greater than or equal to it. | no |
--orgId | string | Unique identifier of the organization for which to retrieve events. | yes |
--output , -o | string | Command output format. Valid values are:
If omitted, the command returns output in the default format. | no |
--page | integer | Page number (1-based). Defaults to 1 if not specified. | no |
--profile , -P | string | Name of the profile where the project ID and the Programmatic API Key |