API >
API Resources >
Events >
Get All Organization Events

Get All Organization Events¶

On this page

Syntax
Response
- Response Document
- results array
Example Request
Example Response

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username and API 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

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.

Request Query Parameters¶

Name Type Description Default

pageNum integer Page number (1-based). 1

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

pretty boolean Display response in a prettyprint format. false

envelope boolean Specifies whether or not to wrap the response in an envelope. false

eventType

string

Returns events whose event type matches the specified value.

Possible values include:

Alert type	Possible values
Host	`OUTSIDE_METRIC_THRESHOLD` `HOST_RESTARTED` `HOST_UPGRADED` `HOST_NOW_SECONDARY` `HOST_NOW_PRIMARY`
Replica set	`NO_PRIMARY` `TOO_MANY_ELECTIONS`
Sharded cluster	`CLUSTER_MONGOS_IS_MISSING`
User	`JOINED_GROUP` `REMOVED_FROM_GROUP` `USER_ROLES_CHANGED_AUDIT`
Project	`USERS_AWAITING_APPROVAL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` `GROUP_CREATED`
Team	`JOINED_TEAM` `REMOVED_FROM_TEAM`
Organization	`INVITED_TO_ORG` `JOINED_ORG`
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` `CHARGE_SUCCEEDED` `INVOICE_CLOSED`

minDate date Returns events whose created date is greater than or equal to the specified ISO-8601 minDate.

maxDate date Returns events whose created date is less than or equal to the specified ISO-8601 maxDate.

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`	object array	Includes one object for each item detailed in the results array section.
`links`	object 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	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 array¶

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.

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

eventTypeName

string

The type of event.

Possible values are:

Alert type	Possible values
Host	`OUTSIDE_METRIC_THRESHOLD` `HOST_RESTARTED` `HOST_UPGRADED` `HOST_NOW_SECONDARY` `HOST_NOW_PRIMARY`
Replica set	`NO_PRIMARY` `TOO_MANY_ELECTIONS`
Sharded cluster	`CLUSTER_MONGOS_IS_MISSING`
User	`JOINED_GROUP` `REMOVED_FROM_GROUP` `USER_ROLES_CHANGED_AUDIT`
Project	`USERS_AWAITING_APPROVAL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` `GROUP_CREATED`
Team	`JOINED_TEAM` `REMOVED_FROM_TEAM`
Organization	`INVITED_TO_ORG` `JOINED_ORG`
Billing	`CREDIT_CARD_ABOUT_TO_EXPIRE` `CHARGE_SUCCEEDED` `INVOICE_CLOSED`

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.

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.

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.

Example Request¶

copy

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

Example Response¶

copy

{
    "links": [
        {
            "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3/events?pageNum=1&itemsPerPage=100",
            "rel": "self"
        }
    ],
    "results": [
        {
            "created": "2018-07-12T16:30:05Z",
            "eventTypeName": "JOINED_TEAM",
            "id": "b3ad04e680eef540be141abe",
            "isGlobalAdmin": true,
            "links": [
                {
                    "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3/events/5b47820d80eef5264e12514a",
                    "rel": "self"
                }
            ],
            "orgId": "5b478b3afc4625789ce616a3",
            "remoteAddress": "203.0.113.22",
            "targetUsername": "b.doe@example.com",
            "userId": "5898b79080eef53b3ad04e68",
            "username": "j.doe@example.com"
        },
        {
            "created": "2018-07-09T21:14:40Z",
            "eventTypeName": "GROUP_CREATED",
            "groupId": "5b43d04087d9d6357de591a2",
            "id": "5b478b3afc49d6357de591af",
            "isGlobalAdmin": false,
            "links": [
                {
                    "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/5b478b3afc4625789ce616a3/events/5b43d04087d9d6357de591af",
                    "rel": "self"
                }
            ],
            "orgId": "5b478b3afc4625789ce616a3",
            "remoteAddress": "192.0.2.88",
            "userId": "5898b79080eef53b3ad04e68",
            "username": "j.doe@example.com"
        }
    ],
    "totalCount": 2
}

← Events Get One Organization Event →