Return Events from One Project

GET /api/atlas/v2/groups/{groupId}/events

Returns events for the specified project. 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 Project Read Only role.

This resource remains under revision and may change.

Path parameters

  • groupId string Required

    Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

    NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

    Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

  • envelope boolean

    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.

    Default value is false.

  • includeCount boolean

    Flag that indicates whether the response returns the total number of items (totalCount) in the response.

    Default value is true.

  • itemsPerPage integer

    Number of items that the response returns per page.

    Minimum value is 1, maximum value is 500. Default value is 100.

  • pageNum integer

    Number of the page that displays the current set of the total objects that the response returns.

    Minimum value is 1. Default value is 1.

  • pretty boolean

    Flag that indicates whether the response body should be in the prettyprint format.

    Default value is false.

    Prettyprint
  • clusterNames array[string]

    Human-readable label that identifies the cluster.

    Format of each should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

  • eventType array[object | string]

    Category of incident recorded at this moment in time.

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

    One of:
    EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string

    Values are ALERT_ACKNOWLEDGED_AUDIT or ALERT_UNACKNOWLEDGED_AUDIT.

  • excludedEventType array[object | string]

    Category of event that you would like to exclude from query results, such as CLUSTER_CREATED

    IMPORTANT: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.

    One of:
    EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string EventTypeForNdsGroup string

    Values are ALERT_ACKNOWLEDGED_AUDIT or ALERT_UNACKNOWLEDGED_AUDIT.

  • includeRaw boolean

    Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

    Default value is false.

  • maxDate string(date-time)

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

    ISO 8601
  • minDate string(date-time)

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

    ISO 8601

Responses

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Hide response attributes Show response attributes object
    • results array[object]

      List of returned documents that MongoDB Cloud provides when completing this request.

      One of:

      Other events which don't have extra details beside of basic one.

      Hide attributes Show attributes
      • apiKeyId string

        Unique 24-hexadecimal digit string that identifies the API Key that triggered the event. If this resource returns this parameter, it doesn't return the userId parameter.

        Format should match the following pattern: ^([a-f0-9]{24})$.

        Create Programmatic API Key
      • created string(date-time) Required

        Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        ISO 8601
      • eventTypeName string Required

        Unique identifier of event type.

        One of:

        Values are AUTO_INDEXING_ENABLED, AUTO_INDEXING_DISABLED, AUTO_INDEXING_INDEX_BUILD_SUBMITTED, AUTO_INDEXING_SLOW_INDEX_BUILD, AUTO_INDEXING_STALLED_INDEX_BUILD, AUTO_INDEXING_FAILED_INDEX_BUILD, AUTO_INDEXING_COMPLETED_INDEX_BUILD, or AUTO_INDEXING_STARTED_INDEX_BUILD.

      • groupId string

        Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The eventId identifies the specific event.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • id string Required

        Unique 24-hexadecimal digit string that identifies the event.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • isGlobalAdmin boolean

        Flag that indicates whether a MongoDB employee triggered the specified event.

      • orgId string

        Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • publicKey string

        Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the username parameter.

        External documentation
      • raw object

        Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter includeRaw=true. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.

        Hide raw attributes Show raw attributes object
        • _t string

          Unique identifier of event type.

        • alertConfigId string

          Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.

          Format should match the following pattern: ^([a-f0-9]{24})$.

        • cid string

          Unique 24-hexadecimal digit string that identifies the project in which the event occurred.

          Format should match the following pattern: ^([a-f0-9]{24})$.

        • cre string(date-time)

          Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

          ISO 8601
        • description string

          Description of the event.

        • gn string

          Human-readable label that identifies the project.

          Minimum length is 1, maximum length is 64.

        • id string

          Unique 24-hexadecimal digit string that identifies the event.

          Format should match the following pattern: ^([a-f0-9]{24})$.

        • orgId string

          Unique 24-hexadecimal digit string that identifies the organization to which these events apply.

          Format should match the following pattern: ^([a-f0-9]{24})$.

        • orgName string

          Human-readable label that identifies the organization that contains the project.

          Minimum length is 1, maximum length is 64.

        • severity string

          Severity of the event.

          Values are INFO, WARNING, ERROR, or CRITICAL.

      • remoteAddress string

        IPv4 or IPv6 address from which the user triggered this event.

        Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

      • userId string

        Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the apiKeyId parameter.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • username string(email)

        Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the publicApiKey parameter.

    • totalCount integer(int32)

      Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.

      Minimum value is 0.

  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 403 application/json

    Forbidden.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 429 application/json

    Too Many Requests.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

GET /api/atlas/v2/groups/{groupId}/events
atlas api listProjectEvents --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListProjectEventsApiParams{}
	sdkResp, httpResp, err := client.EventsApi.
		ListProjectEventsWithParams(ctx, params).
		Execute()
}
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true"
Response examples (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "apiKeyId": "32b6e34b3d91647abb20e7b8",
      "created": "2025-05-04T09:42:00Z",
      "eventTypeName": "AUTO_INDEXING_ENABLED",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "isGlobalAdmin": true,
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "orgId": "32b6e34b3d91647abb20e7b8",
      "publicKey": "string",
      "raw": {
        "_t": "ALERT_AUDIT",
        "alertConfigId": "32b6e34b3d91647abb20e7b8",
        "cid": "32b6e34b3d91647abb20e7b8",
        "cre": "2025-05-04T09:42:00Z",
        "description": "Alert Acknowledged",
        "gn": "Test Project",
        "id": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "orgName": "Test Organization",
        "severity": "INFO"
      },
      "remoteAddress": "216.172.40.186",
      "userId": "32b6e34b3d91647abb20e7b8",
      "username": "hello@example.com"
    }
  ],
  "totalCount": 42
}
Response examples (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Response examples (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Response examples (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}