atlas api events listProjectEvents
On this page
experimental: Returns all events for the specified project.
Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource remains under revision and may change. This command is invoking the endpoint with OperationID: 'listProjectEvents'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents
Syntax
atlas api events listProjectEvents [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterNames | stringArray | false | human-readable label that identifies the cluster |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--eventType | stringArray | false | category of incident recorded at this moment in time |
--excludedEventType | stringArray | false | category of event that you would like to exclude from query results, such as CLUSTER_CREATED IMPORTANT: Event type names change frequently |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for listProjectEvents | |
--includeCount | false | flag that indicates whether the response returns the total number of items (totalCount) in the response | |
--includeRaw | false | flag that indicates whether to include the raw document in the output | |
--itemsPerPage | int | false | number of items that the response returns per page |
--maxDate | string | false | date and time from when MongoDB Cloud stops returning events |
--minDate | string | false | date and time from when MongoDB Cloud starts returning events |
--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) |
--pageNum | int | false | number of the page that displays the current set of the total objects that the response returns |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--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". |
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. |