MongoDB Events API
Returns events. This collection remains under revision and may change.
Returns events. This collection remains under revision and may change.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mongodb-events-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.\n\nTo authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at `POST https://cloud.mongodb.com/api/oauth/token`, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).\n\nFor example, to [return a list of your organizations](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs) with [cURL](https://en.wikipedia.org/wiki/CURL), first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:\n\n```\nACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \\\n --header \"Authorization: Basic $(printf '%s' \"${CLIENT_ID}:${CLIENT_SECRET}\" | base64 | tr -d '\\n')\" \\\n --header \"Content-Type: application/x-www-form-urlencoded\" \\\n --header \"Accept: application/json\" \\\n --data \"grant_type=client_credentials\" | jq -r '.access_token')\n\ncurl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"\n```\n\nIf your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/) (requires a Postman account)."
license:
name: CC BY-NC-SA 3.0 US
url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/
termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
title: MongoDB Atlas Administration Access Tracking Events API
version: '2.0'
x-xgen-sha: 3d70e065843c008b9871ea7836c98c9de6f202f9
servers:
- url: https://cloud.mongodb.com
security:
- ServiceAccounts: []
- DigestAuth: []
tags:
- description: Returns events. This collection remains under revision and may change.
name: Events
paths:
/api/atlas/v2/eventTypes:
get:
description: Returns a list of all event types, along with a description and additional metadata about each event.
operationId: listEventTypes
parameters:
- $ref: '#/components/parameters/envelope'
- $ref: '#/components/parameters/includeCount'
- $ref: '#/components/parameters/itemsPerPage'
- $ref: '#/components/parameters/pageNum'
- $ref: '#/components/parameters/pretty'
responses:
'200':
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/PaginatedEventTypeDetailsResponse'
x-xgen-version: '2023-01-01'
description: OK
headers:
RateLimit-Limit:
$ref: '#/components/headers/HeaderRateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/HeaderRateLimitRemaining'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/tooManyRequests'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return All Event Types
tags:
- Events
x-codeSamples:
- lang: cURL
label: Atlas CLI
source: atlas api events listEventTypes --help
- lang: go
label: Go
source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListEventTypesApiParams{}\n\tsdkResp, httpResp, err := client.EventsApi.\n\t\tListEventTypesWithParams(ctx, params).\n\t\tExecute()\n}\n"
- lang: cURL
label: curl (Service Accounts)
source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\""
- lang: cURL
label: curl (Digest)
source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\""
x-rolesRequirements:
- Organization Member
- Project Read Only
x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes
/api/atlas/v2/groups/{groupId}/events:
get:
description: '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.'
operationId: listGroupEvents
parameters:
- $ref: '#/components/parameters/envelope'
- $ref: '#/components/parameters/groupId'
- $ref: '#/components/parameters/includeCount'
- $ref: '#/components/parameters/itemsPerPage'
- $ref: '#/components/parameters/pageNum'
- $ref: '#/components/parameters/pretty'
- description: Human-readable label that identifies the cluster.
in: query
name: clusterNames
schema:
items:
pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$
type: string
type: array
style: form
- description: 'Category of incident recorded at this moment in time.
**IMPORTANT**: The complete list of event type values changes frequently.'
in: query
name: eventType
schema:
items:
$ref: '#/components/schemas/EventTypeForNdsGroup'
type: array
- description: '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.'
in: query
name: excludedEventType
schema:
items:
$ref: '#/components/schemas/EventTypeForNdsGroup'
type: array
- description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
in: query
name: includeRaw
schema:
default: false
type: boolean
- description: Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
type: string
- description: Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
type: string
responses:
'200':
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/GroupPaginatedEventView'
x-xgen-version: '2023-01-01'
description: OK
headers:
RateLimit-Limit:
$ref: '#/components/headers/HeaderRateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/HeaderRateLimitRemaining'
'400':
$ref: '#/components/responses/badRequest'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'429':
$ref: '#/components/responses/tooManyRequests'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return Events from One Project
tags:
- Events
x-codeSamples:
- lang: cURL
label: Atlas CLI
source: atlas api events listGroupEvents --help
- lang: go
label: Go
source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupEventsApiParams{}\n\tsdkResp, httpResp, err := client.EventsApi.\n\t\tListGroupEventsWithParams(ctx, params).\n\t\tExecute()\n}\n"
- lang: cURL
label: curl (Service Accounts)
source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\""
- lang: cURL
label: curl (Digest)
source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\""
x-rolesRequirements:
- Project Read Only
x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listGroupEvents
/api/atlas/v2/groups/{groupId}/events/{eventId}:
get:
description: 'Returns one event 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. Use the Return Events from One Project endpoint to retrieve all events to which the authenticated user has access.
This resource remains under revision and may change.'
externalDocs:
description: Return Events from One Project
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents
operationId: getGroupEvent
parameters:
- $ref: '#/components/parameters/envelope'
- $ref: '#/components/parameters/groupId'
- $ref: '#/components/parameters/pretty'
- description: Unique 24-hexadecimal digit string that identifies the event that you want to return.
in: path
name: eventId
required: true
schema:
pattern: ^([a-f0-9]{24})$
type: string
- description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
in: query
name: includeRaw
schema:
default: false
type: boolean
responses:
'200':
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/EventViewForNdsGroup'
x-xgen-version: '2023-01-01'
description: OK
headers:
RateLimit-Limit:
$ref: '#/components/headers/HeaderRateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/HeaderRateLimitRemaining'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'429':
$ref: '#/components/responses/tooManyRequests'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return One Event from One Project
tags:
- Events
x-codeSamples:
- lang: cURL
label: Atlas CLI
source: atlas api events getGroupEvent --help
- lang: go
label: Go
source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupEventApiParams{}\n\tsdkResp, httpResp, err := client.EventsApi.\n\t\tGetGroupEventWithParams(ctx, params).\n\t\tExecute()\n}\n"
- lang: cURL
label: curl (Service Accounts)
source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\""
- lang: cURL
label: curl (Digest)
source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\""
x-rolesRequirements:
- Project Read Only
x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getGroupEvent
/api/atlas/v2/orgs/{orgId}/events:
get:
description: 'Returns events for the specified organization. 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 Organization Member role.
This resource remains under revision and may change.'
operationId: listOrgEvents
parameters:
- $ref: '#/components/parameters/envelope'
- $ref: '#/components/parameters/includeCount'
- $ref: '#/components/parameters/itemsPerPage'
- $ref: '#/components/parameters/orgId'
- $ref: '#/components/parameters/pageNum'
- $ref: '#/components/parameters/pretty'
- description: 'Category of incident recorded at this moment in time.
**IMPORTANT**: The complete list of event type values changes frequently.'
in: query
name: eventType
schema:
items:
$ref: '#/components/schemas/EventTypeForOrg'
type: array
- description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
in: query
name: includeRaw
schema:
default: false
type: boolean
- description: Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: maxDate
schema:
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
type: string
- description: Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.
in: query
name: minDate
schema:
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
type: string
responses:
'200':
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/OrgPaginatedEventView'
x-xgen-version: '2023-01-01'
description: OK
headers:
RateLimit-Limit:
$ref: '#/components/headers/HeaderRateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/HeaderRateLimitRemaining'
'400':
$ref: '#/components/responses/badRequest'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'429':
$ref: '#/components/responses/tooManyRequests'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return Events from One Organization
tags:
- Events
x-codeSamples:
- lang: cURL
label: Atlas CLI
source: atlas api events listOrgEvents --help
- lang: go
label: Go
source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListOrgEventsApiParams{}\n\tsdkResp, httpResp, err := client.EventsApi.\n\t\tListOrgEventsWithParams(ctx, params).\n\t\tExecute()\n}\n"
- lang: cURL
label: curl (Service Accounts)
source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\""
- lang: cURL
label: curl (Digest)
source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\""
x-rolesRequirements:
- Organization Member
x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrgEvents
/api/atlas/v2/orgs/{orgId}/events/{eventId}:
get:
description: 'Returns one event for the specified organization. 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 Organization Member role. Use the Return Events from One Organization endpoint to retrieve all events to which the authenticated user has access.
This resource remains under revision and may change.'
externalDocs:
description: Return Events from One Organization
url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents
operationId: getOrgEvent
parameters:
- $ref: '#/components/parameters/envelope'
- $ref: '#/components/parameters/orgId'
- $ref: '#/components/parameters/pretty'
- description: Unique 24-hexadecimal digit string that identifies the event that you want to return.
in: path
name: eventId
required: true
schema:
pattern: ^([a-f0-9]{24})$
type: string
- description: Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.
in: query
name: includeRaw
schema:
default: false
type: boolean
responses:
'200':
content:
application/vnd.atlas.2023-01-01+json:
schema:
$ref: '#/components/schemas/EventViewForOrg'
x-xgen-version: '2023-01-01'
description: OK
headers:
RateLimit-Limit:
$ref: '#/components/headers/HeaderRateLimitLimit'
RateLimit-Remaining:
$ref: '#/components/headers/HeaderRateLimitRemaining'
'401':
$ref: '#/components/responses/unauthorized'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
'429':
$ref: '#/components/responses/tooManyRequests'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return One Event from One Organization
tags:
- Events
x-codeSamples:
- lang: cURL
label: Atlas CLI
source: atlas api events getOrgEvent --help
- lang: go
label: Go
source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetOrgEventApiParams{}\n\tsdkResp, httpResp, err := client.EventsApi.\n\t\tGetOrgEventWithParams(ctx, params).\n\t\tExecute()\n}\n"
- lang: cURL
label: curl (Service Accounts)
source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\""
- lang: cURL
label: curl (Digest)
source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\""
x-rolesRequirements:
- Organization Member
x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrgEvent
components:
schemas:
AtlasResourcePolicyAuditForOrg:
description: Atlas resource policy audits indicate organization level changes to resource policies.
properties:
apiKeyId:
description: 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.
example: 32b6e34b3d91647abb20e7b8
externalDocs:
description: Create Programmatic API Key
url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
created:
description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
readOnly: true
type: string
eventTypeName:
description: Unique identifier of event type.
enum:
- RESOURCE_POLICY_CREATED
- RESOURCE_POLICY_MODIFIED
- RESOURCE_POLICY_DELETED
- RESOURCE_POLICY_VIOLATED
example: RESOURCE_POLICY_CREATED
title: Atlas Resource Policy Audit Types
type: string
groupId:
description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The `eventId` identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
id:
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
isGlobalAdmin:
description: Flag that indicates whether a MongoDB employee triggered the specified event.
readOnly: true
type: boolean
links:
description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
externalDocs:
description: Web Linking Specification (RFC 5988)
url: https://datatracker.ietf.org/doc/html/rfc5988
items:
$ref: '#/components/schemas/Link'
readOnly: true
type: array
orgId:
description: Unique 24-hexadecimal digit string that identifies the organization to which these events apply.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
publicKey:
description: Public part of the API key that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.
externalDocs:
url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
readOnly: true
type: string
raw:
$ref: '#/components/schemas/raw'
remoteAddress:
description: IPv4 or IPv6 address from which the user triggered this event.
example: 216.172.40.186
pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$
readOnly: true
type: string
resourcePolicyId:
description: Unique 24-hexadecimal character string that identifies the resource policy.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
userId:
description: 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.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
username:
description: Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the `publicApiKey` parameter.
format: email
readOnly: true
type: string
required:
- created
- eventTypeName
- id
title: Atlas Resource Policy Audits
type: object
OrgEventTypeViewForOrg:
description: Unique identifier of event type.
enum:
- ORG_CREATED
- CUSTOM_SESSION_TIMEOUT_MODIFIED
- SECURITY_CONTACT_MODIFIED
- ORG_CREDIT_CARD_ADDED
- ORG_CREDIT_CARD_UPDATED
- ORG_CREDIT_CARD_CURRENT
- ORG_CREDIT_CARD_ABOUT_TO_EXPIRE
- ORG_PAYPAL_LINKED
- ORG_PAYPAL_UPDATED
- ORG_PAYPAL_CANCELLED
- ORG_OVERRIDE_PAYMENT_METHOD_ADDED
- ORG_BANK_ACCOUNT_ADDED
- ORG_BANK_ACCOUNT_UPDATED
- ORG_WALLET_ADDED
- ORG_WALLET_UPDATED
- ORG_ACTIVATED
- ORG_TEMPORARILY_ACTIVATED
- ORG_SUSPENSION_DATE_CHANGED
- ORG_SUSPENDED
- ORG_ADMIN_SUSPENDED
- ORG_ADMIN_LOCKED
- ORG_CLUSTERS_DELETED
- ORG_CLUSTERS_PAUSED
- ORG_LOCKED
- ORG_LOCKED_ACCELERATED
- ORG_UNDER_FINANCIAL_PROTECTION
- ORG_NO_FINANCIAL_PROTECTION
- ORG_RENAMED
- ALL_ORG_USERS_HAVE_MFA
- ORG_USERS_WITHOUT_MFA
- ORG_INVOICE_UNDER_THRESHOLD
- ORG_INVOICE_OVER_THRESHOLD
- ORG_DAILY_BILL_UNDER_THRESHOLD
- ORG_DAILY_BILL_OVER_THRESHOLD
- ORG_DAILY_BILLING_CHANGE_NORMAL
- ORG_DAILY_BILLING_CHANGE_OVER_THRESHOLD
- ORG_WEEKLY_BILLING_CHANGE_NORMAL
- ORG_WEEKLY_BILLING_CHANGE_OVER_THRESHOLD
- ORG_MONTHLY_BILLING_CHANGE_NORMAL
- ORG_MONTHLY_BILLING_CHANGE_OVER_THRESHOLD
- ORG_GROUP_CHARGES_UNDER_THRESHOLD
- ORG_GROUP_CHARGES_OVER_THRESHOLD
- ORG_TWO_FACTOR_AUTH_REQUIRED
- ORG_TWO_FACTOR_AUTH_OPTIONAL
- ORG_PUBLIC_API_ACCESS_LIST_REQUIRED
- ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED
- ORG_EMPLOYEE_ACCESS_RESTRICTED
- ORG_EMPLOYEE_ACCESS_UNRESTRICTED
- ORG_CONNECTED_TO_MLAB
- ORG_DISCONNECTED_FROM_MLAB
- ORG_IDP_CERTIFICATE_CURRENT
- ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE
- ORG_CONNECTED_TO_VERCEL
- ORG_DISCONNECTED_TO_VERCEL
- ORG_CONNECTION_UNINSTALLED_FROM_VERCEL
- ORG_UI_IP_ACCESS_LIST_ENABLED
- ORG_UI_IP_ACCESS_LIST_DISABLED
- ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES
- ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED
- ORG_SERVICE_ACCOUNT_SECRETS_EXPIRED
- ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED
- ORG_SERVICE_ACCOUNT_SECRETS_EXPIRING
- ORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING
- ORG_MONGODB_VERSION_EOL_EXTENSION_ACCEPTED
- ORG_MONGODB_VERSION_EOL_EXTENSION_PENDING
- ORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLED
- ORG_BAAS_EOL_EXTENSION_ACCEPTED
- ORG_BAAS_EOL_EXTENSION_PENDING
- ORG_BAAS_EOL_EXTENSION_CANCELED
- GROUP_MOVED_FROM_ORG
- SANDBOX_ENABLED_FOR_ORG
- SANDBOX_DISABLED_FOR_ORG
- SANDBOX_CONFIG_DELETED
- SANDBOX_TEMPLATE_UPDATED
- ORGANIZATION_VOYAGE_SETTINGS_CREATED
- ORGANIZATION_VOYAGE_SETTINGS_DELETED
- PROJECT_CREATED_VIA_ANIS
example: ORG_CREATED
title: Org Event Types
type: string
HostMetricEventTypeView:
description: Unique identifier of event type.
enum:
- INSIDE_METRIC_THRESHOLD
- OUTSIDE_METRIC_THRESHOLD
example: OUTSIDE_METRIC_THRESHOLD
title: Host Metric Event Types
type: string
TeamEventViewForNdsGroup:
description: Team event identifies different activities around organization teams.
properties:
apiKeyId:
description: 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.
example: 32b6e34b3d91647abb20e7b8
externalDocs:
description: Create Programmatic API Key
url: https://dochub.mongodb.org/core/atlas-create-prog-api-key
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
created:
description: Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
externalDocs:
description: ISO 8601
url: https://en.wikipedia.org/wiki/ISO_8601
format: date-time
readOnly: true
type: string
eventTypeName:
$ref: '#/components/schemas/TeamEventTypeViewForNdsGroup'
groupId:
description: Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The `eventId` identifies the specific event.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
id:
description: Unique 24-hexadecimal digit string that identifies the event.
example: 32b6e34b3d91647abb20e7b8
pattern: ^([a-f0-9]{24})$
readOnly: true
type: string
isGlobalAdmin:
description: Flag that indicates whether a MongoDB employee triggered the specified event.
readOnly: true
type: boolean
links:
description: List of one or more Uniform Resource Locators (URLs) that point to A
# --- truncated at 32 KB (286 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/openapi/mongodb-events-api-openapi.yml