Get All Project Events
On this page
Required Roles
Your API Key must have the Project Read Only
role to
successfully call this resource.
Request
Base URL: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{groupId}/events
Request Path Parameters
Name | Type | Description |
---|---|---|
groupId | string | Unique identifier of the project associated with the
desired event. |
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 IMPORTANT: The values in the | 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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the | None |
Request Body Parameters
This endpoint doesn't 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 |
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. For 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:
|
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
|
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 |
raw | document | Additional meta information about the event. This field only
appears when the IMPORTANT: The values in the |
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 |
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
|
accessListEntry | string | Access list entry of the API Key targeted by the event. |
Example Request
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true"
Example Response
Response Header
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
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
1 { 2 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 }, { 6 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel" : "next" 8 } ], 9 "results" : [ { 10 "created" : "2020-07-13T21:28:37Z", 11 "diffs" : [ { 12 "id" : "admin@admin", 13 "name" : null, 14 "params" : [ { 15 "display" : "Added Privilege", 16 "new" : "config.system.sessions: moveChunk", 17 "old" : null, 18 "param" : "config.system.sessions: moveChunk" 19 }, { 20 "display" : "Added Privilege", 21 "new" : "config.system.sessions: splitChunk", 22 "old" : null, 23 "param" : "config.system.sessions: splitChunk" 24 }, { 25 "display" : "Added Privilege", 26 "new" : "config.system.sessions: splitVector", 27 "old" : null, 28 "param" : "config.system.sessions: splitVector" 29 } ], 30 "priviileges" : [ { 31 "actions" : [ "moveChunk" ], 32 "resource" : { 33 "collection" : "system.sessions", 34 "db" : "config" 35 } 36 }, { 37 "actions" : [ "moveChunk" ], 38 "resource" : { 39 "collection" : "", 40 "db" : "" 41 } 42 }, { 43 "actions" : [ "enableSharding" ], 44 "resource" : { 45 "cluster" : true 46 } 47 }, { 48 "actions" : [ "cleanupOrphaned" ], 49 "resource" : { 50 "cluster" : true 51 } 52 }, { 53 "actions" : [ "flushRouterConfig" ], 54 "resource" : { 55 "cluster" : true 56 } 57 }, { 58 "actions" : [ "splitChunk" ], 59 "resource" : { 60 "collection" : "system.sessions", 61 "db" : "config" 62 } 63 }, { 64 "actions" : [ "splitChunk" ], 65 "resource" : { 66 "collection" : "", 67 "db" : "" 68 } 69 }, { 70 "actions" : [ "splitVector" ], 71 "resource" : { 72 "collection" : "system.sessions", 73 "db" : "config" 74 } 75 }, { 76 "actions" : [ "viewRole" ], 77 "resource" : { 78 "collection" : "", 79 "db" : "" 80 } 81 } ], 82 "roles" : [ { 83 "db" : "admin", 84 "role" : "readWriteAnyDatabase" 85 }, { 86 "db" : "admin", 87 "role" : "dbAdminAnyDatabase" 88 }, { 89 "db" : "admin", 90 "role" : "enableSharding" 91 }, { 92 "db" : "admin", 93 "role" : "backup" 94 }, { 95 "db" : "admin", 96 "role" : "clusterMonitor" 97 } ], 98 "status" : "MODIFIED", 99 "type" : "ROLES" 100 }, { 101 "id" : "sample-dataset-load@admin", 102 "name" : null, 103 "params" : [ ], 104 "priviileges" : null, 105 "roles" : [ { 106 "db" : "admin", 107 "role" : "readWriteAnyDatabase" 108 } ], 109 "status" : "NEW", 110 "type" : "USERS" 111 }, { 112 "id" : "10.16.0.6482-1", 113 "name" : null, 114 "params" : [ { 115 "display" : "Version", 116 "new" : "10.16.0.6482-1", 117 "old" : "10.12.0.6179-1", 118 "param" : "version" 119 } ], 120 "status" : "MODIFIED", 121 "type" : "AUTOMATION_AGENT" 122 } ], 123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", 124 "groupId" : "{groupId}", 125 "id" : "{eventId}", 126 "isGlobalAdmin" : false, 127 "links" : [ { 128 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{eventId}", 129 "rel" : "self" 130 } ] 131 }], 132 "totalCount" : 1 133 }