Get All Organization Events¶

On this page

Required Roles
Request
Response
- Response Document
- results Embedded Document
Example Request
Example Response
- Response Header
- Response Body

Required Roles¶

Your API Key must have the Organization Member role to successfully call this resource.

Request¶

Base URL: https://cloud.mongodb.com/api/public/v1.0

GET /orgs/{orgId}/events

Request Path Parameters¶

This endpoint does not use HTTP request path parameters.

Request Query Parameters¶

Unique Query Parameters¶

This endpoint accepts the following query parameters to filter returned events:

Name	Type	Description	Default
eventType	string	Return only events of the specified types. To review the types of events that generate alerts, see Alert Types.
includeRaw	boolean	Specifies whether to include the `raw` document in the output. The `raw` document contains additional meta information about the event. Important The values in the `raw` document are subject to change. Do not rely on `raw` values for formal monitoring.	`false`
minDate	string	Return only events for which the created date is greater than or equal to the specified Timestamp in ISO 8601 date and time format in UTC.
maxDate	string	Return only events for which the created date is less than or equal to the specified Timestamp in ISO 8601 date and time format in UTC.

Common Query Parameters¶

This endpoint also accepts the query parameters common to all endpoints that return lists of values:

Name Type Description Default

pageNum integer Page number (1-index based). 1

itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100

pretty boolean Indicates whether the response body should be in a prettyprint format. false

envelope

boolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set "envelope" : true in the query.

For endpoints that return one result, response body includes:

status	HTTP response code
envelope	Expected response body

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

None

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Response Document¶

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name	Type	Description
`results`	array	Array includes one object for each item detailed in the results Embedded Document section.
`links`	array	Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`totalCount`	number	Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document¶

Each result is one event.

Name	Type	Description
alertId	string	Unique identifier for the alert associated with this event.
alertConfigId	string	Unique identifier for the alert configuration associated with the `alertId`.
apiKeyId	string	Unique identifier for the API Key that triggered this event. If this field is present in the response, Cloud Manager does not return the `userId` field.
clusterId	string	ID of the cluster to which this event applies.
clusterName	string	Name of the cluster to which this event applies.
collection	string	Name of the collection on which the event occurred. This field can be present when the `eventTypeName` is either `DATA_EXPLORER` or `DATA_EXPLORER_CRUD`.
created	string	Timestamp in ISO 8601 date and time format in UTC when this event was triggered.
currentValue	object	Current value of the metric that triggered this event.
currentValue .number	number	Value of the metric.
currentValue .units	string	Relevant units for the value. Example A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Accepted values are: `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
database	string	Name of the database on which the event occurred. This field can be present when the `eventTypeName` is either `DATA_EXPLORER` or `DATA_EXPLORER_CRUD`.
eventTypeName	string	Name of the circumstance that triggered this event. To review the types of events that generate alerts, see Alert Types.
groupId	string	ID of the project in which this event occurred.
hostId	string	ID of the host on which this event occurred.
hostname	string	Hostname, FQDN, IPv4 address, or IPv6 address of the host on which this event occurred.
id	string	Unique identifier for this event.
invoiceId	string	Unique identifier of the invoice associated with this event.
isGlobalAdmin	boolean	Flag indicating whether the user who triggered this event is a MongoDB employee.
links	object array	One or more links to sub-resources and/or related resources. All `links` arrays in responses include at least one link called `self`. The relationships between URLs are explained in the Web Linking Specification.
metricName	string	Name of the measurement whose value went outside the threshold. For possible values, see below.
opType	string	Type of operation that generated the event. This field is present when the `eventTypeName` is either `DATA_EXPLORER` or `DATA_EXPLORER_CRUD`.
paymentId	string	Unique identifier of the invoice payment associated with this event.
port	integer	Port of the host associated with this event.
publicKey	string	Public key associated with the API Key that triggered this event. If this field is present in the response, Cloud Manager does not return the `username` field.
raw	document	Additional meta information about the event. This field only appears when the `includeRaw` query parameter is `true`. Important The values in the `raw` document are subject to change. Do not rely on `raw` values for formal monitoring.
remoteAddress	string	IP address associated with the Cloud Manager user (userId) who triggered the event.
replicaSetName	string	Name of the replica set.
shardName	string	The name of the shard associated with the event.
targetPublicKey	string	Public key of the API Key targeted by the event.
targetUsername	string	Username for the Cloud Manager user targeted by this event.
teamId	string	Unique identifier for the Cloud Manager team associated with this event.
userId	string	Unique identifier for the Cloud Manager user who triggered this event. If this field is present in the response, Cloud Manager does not return the `apiKeyId` field.
username	string	Username for the Cloud Manager user who triggered this event. If this field is present in the response, Cloud Manager does not return `publicKey` field.
whitelistEntry	string	Whitelist entry of the API Key targeted by the event.

Example Request¶

copy

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{orgId}/events?pretty=true"

Example Response¶

Response Header¶

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body¶