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

atlas api events listOrganizationEvents

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Public Preview: please provide feedback at: Returns all events for the specified organization.

Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting Service Account or API Key must have the Organization Member role.

This resource remains under revision and may change.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax
atlas api events listOrganizationEvents [options]

Options

Name
Type
Required
Description

--envelope

envelope

false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

--eventType

stringArray

false

Category of incident recorded at this moment in time.

IMPORTANT: The complete list of event type values changes frequently.

-h, --help

false

help for listOrganizationEvents

--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. The raw document contains additional meta information about the event.

--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. This parameter uses the ISO 8601 timestamp format in UTC.

--minDate

string

false

Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.

--orgId

string

true

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.

--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.

Examples

atlas api events listOrganizationEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61

Back

listEventTypes

Next

listProjectEvents