API >
API Resources >
Events >
Get One Organization Event

Get One Organization Event¶

On this page

Syntax
Response
Example Request
Example Response

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax¶

copy

GET /orgs/{ORG-ID}/events/{EVENT-ID}

Request Path Parameters¶

Path Element	Required/Optional	Description
`ORG-ID`	Required	The unique identifier for the organization whose events you want to retrieve. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
`EVENT-ID`	Required	The unique identifier for the event which you want to retrieve.

Request Query Parameters¶

The following query parameters are optional:

Query Parameter	Type	Description	Default
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Name Type Description

alertId string Unique identifier for the alert associated to the event.

alertConfigId string Unique identifier for the alert configuration associated to the alertId.

apiKeyId string Unique identifier for the API Key that triggered the event. If this field is present in the response, Atlas does not return the userId field.

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 date ISO 8601-formatted UTC date when the event occurred.

currentValue document Describes the value of the metricName at the time of the event.

currentValue.number int The value of the metricName at the time of the event.

currentValue.units

string

The unit of measurement of the currentValue.number.

Possible 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

The type of event.

Possible values are:

Alert Target	Condition
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` Credit card is about to expire `PENDING_INVOICE_OVER_THRESHOLD` Monthly pending invoice ($) total is… `DAILY_BILL_OVER_THRESHOLD` Daily amount billed ($) is…
Encryption Key	`AWS_ENCRYPTION_KEY_NEEDS_ROTATION` AWS encryption key elapsed time since last rotation is… `AZURE_ENCRYPTION_KEY_NEEDS_ROTATION` Azure encryption key elapsed time since last rotation is… `GCP_ENCRYPTION_KEY_NEEDS_ROTATION` GCP encryption key elapsed time since last rotation is…
Host	`HOST_DOWN` Host is down `OUTSIDE_METRIC_THRESHOLD` Click the Metrics tab beneath Request Body Parameters.
Project	`USERS_WITHOUT_MULTIFACTOR_AUTH` Users do not have two-factor authentication enabled
Replica Set	`PRIMARY_ELECTED` Replica set elected a new primary `NO_PRIMARY` Replica set has no primary `TOO_MANY_ELECTIONS` Number of election events is… `REPLICATION_OPLOG_WINDOW_RUNNING_OUT` Replication Oplog Window is…
Sharded Cluster	`CLUSTER_MONGOS_IS_MISSING` Cluster is missing an active mongos
User	`USER_ROLES_CHANGED_AUDIT` User had their role changed `JOINED_GROUP` User joined the project `REMOVED_FROM_GROUP` User left the project `USER_ROLES_CHANGED_AUDIT` User had their role changed
X.509	`NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK` X.509 User Authentication, Client Certificates Expiration Alert when days to expiration is… `NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK` X.509 User Authentication, Self-Managed CA Expiration Alert when days to expiration is…

groupId string The unique identifier for the project in which the event occurred.

hostname string The hostname of the Atlas host machine associated to the event.

id string The unique identifier for the event.

invoiceId string The unique identifier of the invoice associated to the event.

isGlobalAdmin boolean Indicates whether the user who triggered the event is a MongoDB employee.

links array One or more links to sub-resources and/or related resources. The relation-types between URLs are explained in the Web Linking Specification.

metricName string The name of the metric associated to the alertId.

opType string Type of operation that occurred. This field is present when the eventTypeName is either DATA_EXPLORER or DATA_EXPLORER_CRUD.

orgId string The unique identifier for the organization in which the event occurred.

paymentId string The unique identifier of the invoice payment associated to the event.

port int The port on which the mongod or mongos listens.

publicKey string Public key associated with the API Key that triggered the event. If this field is present in the response, Atlas does not return the username field.

remoteAddress string IP address of the userId Atlas user who triggered the event.

replicaSetName string The name of the replica set associated to the event.

shardName string The name of the shard associated to the event.

targetPublicKey string The public key of the API Key targeted by the event.

targetUsername string The username for the Atlas user targeted by the event.

teamId string The unique identifier for the Atlas team associated to the event.

userId string The unique identifier for the Atlas user who triggered the event. If this field is present in the response, Atlas does not return the apiKeyId field.

username string The username for the Atlas user who triggered the event. If this field is present in the response, Atlas does not return the publicKey field.

whitelistEntry string The white list entry of the API Key targeted by the event.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
  --header "Content-Type: application/json" \
  "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3/events/5b48f4d2d7e33a1c0c60597e"

Example Response¶

copy

{
  "created": "2018-06-19T15:06:15Z",
  "eventTypeName": "JOINED_ORG",
  "id": "5b48f4d2d7e33a1c0c60597e",
  "isGlobalAdmin": false,
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3",
      "rel": "http://mms.mongodb.com/org"
    },
    {
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/users/6b610e1087d9d66b272f0c86",
      "rel": "http://mms.mongodb.com/user"
    },
    {
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3/events/5b48f4d2d7e33a1c0c60597e",
      "rel": "self"
    }
  ],
  "orgId": "5b478b3afc4625789ce616a3",
  "remoteAddress": "198.51.100.64",
  "targetUsername": "j.doe@example.com",
  "userId": "6b610e1087d9d66b272f0c86",
  "username": "j.doe@example.com"
}

← Get All Organization Events Get All Project Events →