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})$.

• eventId string Required

  Unique 24-hexadecimal digit string that identifies the event that you want to return.

  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.

• pretty boolean

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

  Default value is false.

  Prettyprint
• 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.

Responses

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

  OK

  Hide headers attributes Show headers attributes

  • RateLimit-Limit

    The maximum number of requests that a user can make within a specific time window.

  • RateLimit-Remaining

    The number of requests remaining in the current rate limit window before the limit is reached.

  One of:

  Any Other Events object Alert Audits object Alert Config Audits object API User Events object ServiceAccount Events object Automation Config Events object App Services Events object Billing Events object Cluster Events object Data Explorer Accessed Events object Data Explorer Events object FTS Index Audits object Host Events object HostMetricEvent object Atlas Project Audits object Auto Scaling Audits object Serverless Instance Audits object Tenant Endpoint Audits object ReplicaSet Events object Search Deployment Audits object Team Events object User Events object Resource Events object Streams Events object Stream Processor Events object ChartsAudit object Atlas Resource Policy Audits For Atlas Group object

  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:

    Auto Indexing Event Types string AWS Peer Vpc Audit Types string Azure Peer Network Audit Types string Cluster Connection Audit Types string Cps Backup Event Types string CPS Backup Compliance Policy Event Types string Disk Backup Event Types string Encryption Event Types string Export Bucket Audit Types string GCP Peer Vpc Audit Types string Group Audit Types string Group Event Types string Group Integration Event Types string Index Build Audit Types string DB Check Audit Types string Data Validation Audit Types string Maintenance Window Audit Types string Serverless Auto Scaling Audit Types string Tenant Endpoint Service Deployment Audit Types string x509 User Auth Event Types string Online Archive Event Types string Private Link Audit Types string Proactive Operation Event Types string Search Deployment Audit Types string Serverless Deployment Audit Types string Serverless Event Types string Flex Metric Event Types string Setup Serverless Audit Types string Streams Event Types string Stream Processor Event Types string Support Case Event Types string Support Event Types string Tenant Backup Event Types string Version Audit Types string Access Event Types string Query Shape Event Types string Mongotune Event Types string

    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.

    Values are PEER_CREATED, PEER_DELETED, or PEER_UPDATED.

    Values are AZURE_PEER_CREATED, AZURE_PEER_UPDATED, AZURE_PEER_ACTIVE, or AZURE_PEER_DELETED.

    Values are CLUSTER_CONNECTION_GET_DATABASES, CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS, CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES, CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID, CLUSTER_CONNECTION_GET_AGGREGATED_VIEW_INFOS, CLUSTER_CONNECTION_AGGREGATE, CLUSTER_CONNECTION_CREATE_COLLECTION, CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES, CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES_AND_TYPES, or CLUSTER_CONNECTION_GET_NAMESPACES_AND_PROJECT_SQL_SCHEMA_DATA.

    Values are CPS_SNAPSHOT_STARTED, CPS_SNAPSHOT_SUCCESSFUL, CPS_SNAPSHOT_FAILED, CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY, CPS_SNAPSHOT_FALLBACK_SUCCESSFUL, CPS_SNAPSHOT_BEHIND, CPS_COPY_SNAPSHOT_STARTED, CPS_COPY_SNAPSHOT_FAILED, CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY, CPS_COPY_SNAPSHOT_SUCCESSFUL, CPS_PREV_SNAPSHOT_OLD, CPS_SNAPSHOT_FALLBACK_FAILED, CPS_RESTORE_SUCCESSFUL, CPS_EXPORT_SUCCESSFUL, CPS_RESTORE_FAILED, CPS_EXPORT_FAILED, CPS_COLLECTION_RESTORE_SUCCESSFUL, CPS_COLLECTION_RESTORE_FAILED, CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS, CPS_COLLECTION_RESTORE_CANCELED, CPS_AUTO_EXPORT_FAILED, CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED, CPS_OPLOG_BEHIND, or CPS_OPLOG_CAUGHT_UP.

    Values are CPS_DATA_PROTECTION_ENABLE_REQUESTED, CPS_DATA_PROTECTION_ENABLED, CPS_DATA_PROTECTION_UPDATE_REQUESTED, CPS_DATA_PROTECTION_UPDATED, CPS_DATA_PROTECTION_DISABLE_REQUESTED, CPS_DATA_PROTECTION_DISABLED, or CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT.

    Values are CPS_RESTORE_REQUESTED_AUDIT, CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT, CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT, CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT, CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT, CPS_SNAPSHOT_DELETED_AUDIT, CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT, CPS_SNAPSHOT_IN_PROGRESS_AUDIT, CPS_SNAPSHOT_COMPLETED_AUDIT, CPS_ON_DEMAND_SNAPSHOT_REQUESTED, CPS_OPLOG_CAUGHT_UP_AUDIT, or CPS_OPLOG_BEHIND_AUDIT.

    Values are AWS_ENCRYPTION_KEY_ROTATED, AWS_ENCRYPTION_KEY_NEEDS_ROTATION, AZURE_ENCRYPTION_KEY_ROTATED, AZURE_ENCRYPTION_KEY_NEEDS_ROTATION, GCP_ENCRYPTION_KEY_ROTATED, GCP_ENCRYPTION_KEY_NEEDS_ROTATION, AWS_ENCRYPTION_KEY_VALID, AWS_ENCRYPTION_KEY_INVALID, AZURE_ENCRYPTION_KEY_VALID, AZURE_ENCRYPTION_KEY_INVALID, GCP_ENCRYPTION_KEY_VALID, or GCP_ENCRYPTION_KEY_INVALID.

    Values are BUCKET_CREATED_AUDIT or BUCKET_DELETED_AUDIT.

    Values are GCP_PEER_CREATED, GCP_PEER_DELETED, GCP_PEER_UPDATED, GCP_PEER_ACTIVE, or GCP_PEER_INACTIVE.

    Values are DATA_EXPLORER_ENABLED, DATA_EXPLORER_DISABLED, CREDIT_CARD_ADDED, CREDIT_CARD_UPDATED, GROUP_DELETED, GROUP_CREATED, GROUP_MOVED, GROUP_TEMPORARILY_ACTIVATED, GROUP_ACTIVATED, GROUP_LOCKED, GROUP_SUSPENDED, GROUP_FLUSHED, GROUP_NAME_CHANGED, GROUP_CHARTS_ACTIVATION_REQUESTED, GROUP_CHARTS_ACTIVATED, GROUP_CHARTS_UPGRADED, or GROUP_CHARTS_RESET.

    Values are PAID_IN_FULL, DELINQUENT, ALL_USERS_HAVE_MULTI_FACTOR_AUTH, USERS_WITHOUT_MULTI_FACTOR_AUTH, ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED, ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED, ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID, ENCRYPTION_AT_REST_CONFIG_IS_VALID, GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRING, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING, GROUP_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRED, GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED, ACTIVE_LEGACY_TLS_CONNECTIONS, or NO_ACTIVE_LEGACY_TLS_CONNECTIONS.

    Values are INTEGRATION_CONFIGURED or INTEGRATION_REMOVED.

    Values are ROLLING_INDEX_FAILED_INDEX_BUILD, ROLLING_INDEX_SUCCESS_INDEX_BUILD, INDEX_FAILED_INDEX_BUILD, or INDEX_SUCCESS_INDEX_BUILD.

    Values are DB_CHECK_UPDATED, CLUSTER_SAMPLED_FOR_DB_CHECK, DB_CHECK_SCHEDULED_FOR_CLUSTER, DB_CHECK_DEFERRED_FOR_CLUSTER, or CLUSTER_OPTED_OUT_OF_DB_CHECK.

    Values are CLUSTER_SAMPLED_FOR_DATA_VALIDATION, DATA_VALIDATION_SUBMITTED_FOR_CLUSTER, CLUSTER_OPTED_OUT_OF_DATA_VALIDATION, REPLICA_SET_SAMPLED_FOR_INTER_NODE_DATA_VALIDATION, REPLICA_SET_OPTED_OUT_OF_INTER_NODE_DATA_VALIDATION, or INTER_NODE_DATA_VALIDATION_SUBMITTED_FOR_REPLICA_SET.

    Values are MAINTENANCE_IN_ADVANCED, MAINTENANCE_AUTO_DEFERRED, MAINTENANCE_STARTED, MAINTENANCE_COMPLETED, or MAINTENANCE_NO_LONGER_NEEDED.

    Values are SERVERLESS_AUTO_SCALING_INITIATED, SERVERLESS_VERTICAL_SCALING_INITIATED, SERVERLESS_HORIZONTAL_SCALING_INITIATED, SERVERLESS_MTM_DRAIN_REQUESTED, SERVERLESS_MTM_DRAIN_INITIATED, SERVERLESS_MTM_DRAIN_COMPLETED, or SERVERLESS_MTM_DRAIN_STOPPED.

    Values are TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED, TENANT_ENDPOINT_SERVICE_CREATED, TENANT_ENDPOINT_SERVICE_AVAILABLE, TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED, TENANT_ENDPOINT_SERVICE_DELETED, TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED, or TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED.

    Values are NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED, NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK, NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED, NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK, NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED, or NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK.

    Values are ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK, ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED, ONLINE_ARCHIVE_UP_TO_DATE, ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED, or ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK.

    Values are ENDPOINT_SERVICE_CREATED, ENDPOINT_SERVICE_DELETED, INTERFACE_ENDPOINT_CREATED, INTERFACE_ENDPOINT_DELETED, or INTERFACE_ENDPOINT_PATCHED.

    Value is PROACTIVE_OPERATION_EVENT_LOGGED.

    Values are SEARCH_DEPLOYMENT_CREATED, SEARCH_DEPLOYMENT_UPDATED, or SEARCH_DEPLOYMENT_DELETED.

    Values are SERVERLESS_DEPLOYMENT_CREATED, SERVERLESS_DEPLOYMENT_DELETED, SERVERLESS_DEPLOYMENT_UPDATED, SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED, SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED, SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED, SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED, or SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED.

    Values are INSIDE_SERVERLESS_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.

    Values are INSIDE_FLEX_METRIC_THRESHOLD or OUTSIDE_FLEX_METRIC_THRESHOLD.

    Value is SETUP_SERVERLESS_INITIATED.

    Value is MAX_PROCESSOR_COUNT_REACHED.

    Values are STREAM_PROCESSOR_STATE_IS_FAILED, INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD, or OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD.

    Value is CASE_CREATED.

    Values are SUPPORT_EMAILS_SENT_SUCCESSFULLY or SUPPORT_EMAILS_SENT_FAILURE.

    Values are TENANT_SNAPSHOT_STARTED_AUDIT, TENANT_SNAPSHOT_COMPLETED_AUDIT, TENANT_SNAPSHOT_DELETED_AUDIT, TENANT_RESTORE_REQUESTED_AUDIT, TENANT_RESTORE_COMPLETED_AUDIT, or TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT.

    Values are CLUSTER_FCV_FIXED, CLUSTER_FCV_UNFIXED, CLUSTER_FCV_EXPIRATION_DATE_UPDATED, CLUSTER_FCV_DOWNGRADED, CLUSTER_BINARY_VERSION_DOWNGRADED, CLUSTER_BINARY_VERSION_UPGRADED, CLUSTER_OS_FIXED, or CLUSTER_OS_UNFIXED.

    Value is EMPLOYEE_DOWNLOADED_CLUSTER_LOGS.

    Values are QUERY_SHAPE_BLOCKED or QUERY_SHAPE_UNBLOCKED.

    Values are MONGOTUNE_INFO or MONGOTUNE_ALERT.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Alert audit indicates acknowledgement status of an alert.

  Hide attributes Show attributes

  • alertId string

    Unique 24-hexadecimal digit string that identifies the alert associated with the event.

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

  • 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.

    Values are ALERT_ACKNOWLEDGED_AUDIT or ALERT_UNACKNOWLEDGED_AUDIT.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Alert configuration audit indicates any activities around alert settings.

  Hide attributes Show attributes

  • alertConfigId string

    Unique 24-hexadecimal digit string that identifies the alert configuration associated with the alertId.

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

  • 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.

    Values are ALERT_CONFIG_DISABLED_AUDIT, ALERT_CONFIG_ENABLED_AUDIT, ALERT_CONFIG_ADDED_AUDIT, ALERT_CONFIG_DELETED_AUDIT, or ALERT_CONFIG_CHANGED_AUDIT.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  API User event identifies different activities around user API keys.

  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.

    Values are API_KEY_CREATED, API_KEY_DELETED, API_KEY_ACCESS_LIST_ENTRY_ADDED, API_KEY_ACCESS_LIST_ENTRY_DELETED, API_KEY_ROLES_CHANGED, API_KEY_DESCRIPTION_CHANGED, API_KEY_ADDED_TO_GROUP, API_KEY_REMOVED_FROM_GROUP, API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED, or API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • targetPublicKey string

    Public part of the API key that this event targets.

  • 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.

  • whitelistEntry string

    Entry in the list of source host addresses that the API key accepts and this event targets.

  Service Account event identifies different activities around user API keys.

  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.

    Values are SERVICE_ACCOUNT_CREATED, SERVICE_ACCOUNT_DELETED, SERVICE_ACCOUNT_ROLES_CHANGED, SERVICE_ACCOUNT_DETAILS_CHANGED, SERVICE_ACCOUNT_ADDED_TO_GROUP, SERVICE_ACCOUNT_REMOVED_FROM_GROUP, SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED, SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED, SERVICE_ACCOUNT_SECRET_ADDED, SERVICE_ACCOUNT_SECRET_DELETED, SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED, or SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Automation configuration event identifies that deployment configuration is published.

  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.

    Value is AUTOMATION_CONFIG_PUBLISHED_AUDIT.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  App Services event identifies different activities about a BAAS application.

  Hide attributes Show attributes

  • 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.

    Values are URL_CONFIRMATION, SUCCESSFUL_DEPLOY, DEPLOYMENT_FAILURE, DEPLOYMENT_MODEL_CHANGE_SUCCESS, DEPLOYMENT_MODEL_CHANGE_FAILURE, REQUEST_RATE_LIMIT, LOG_FORWARDER_FAILURE, INSIDE_REALM_METRIC_THRESHOLD, OUTSIDE_REALM_METRIC_THRESHOLD, SYNC_FAILURE, TRIGGER_FAILURE, or TRIGGER_AUTO_RESUMED.

  • 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})$.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • 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.

  Billing event identifies different activities related to billing, payment or financial status change of an organization.

  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.

    Values are CREDIT_CARD_CURRENT, CREDIT_CARD_ABOUT_TO_EXPIRE, PENDING_INVOICE_UNDER_THRESHOLD, PENDING_INVOICE_OVER_THRESHOLD, DAILY_BILL_UNDER_THRESHOLD, or DAILY_BILL_OVER_THRESHOLD.

  • 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})$.

  • invoiceId string

    Unique 24-hexadecimal digit string that identifies of the invoice associated with 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • paymentId string

    Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.

    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.

  Cluster event identifies different activities about cluster of mongod hosts.

  Hide attributes Show attributes

  • 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.

    Values are CLUSTER_MONGOS_IS_PRESENT or CLUSTER_MONGOS_IS_MISSING.

  • 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})$.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • 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.

  • shardName string

    Human-readable label of the shard associated with the event.

  Data Explorer accessed event tracks different data operations via Data Explorer interactions.

  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
  • collection string

    Human-readable label of the collection on which the event occurred. The resource returns this parameter when the eventTypeName includes DATA_EXPLORER.

  • 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
  • database string

    Human-readable label of the database on which this incident occurred. The resource returns this parameter when "eventTypeName" : "DATA_EXPLORER" or "eventTypeName" : "DATA_EXPLORER_CRUD".

  • eventTypeName string Required

    Unique identifier of event type.

    Values are DATA_EXPLORER, DATA_EXPLORER_CRUD_ATTEMPT, DATA_EXPLORER_CRUD_ERROR, or DATA_EXPLORER_CRUD.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • opType string

    Action that the database attempted to execute when the event triggered. The response returns this parameter when eventTypeName" : "DATA_EXPLORER".

  • 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.

  Data Explorer event tracks different Data Explorer operations.

  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.

    Value is DATA_EXPLORER_SESSION_CREATED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • sessionId string

    Unique 24-hexadecimal digit string that identifies the Data Explorer session associated with the event.

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

  • 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.

  FTS index audit indicates any activities about search index.

  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.

    Values are FTS_INDEX_DELETION_FAILED, FTS_INDEX_BUILD_COMPLETE, FTS_INDEX_BUILD_FAILED, FTS_INDEX_CREATED, FTS_INDEX_UPDATED, FTS_INDEX_DELETED, FTS_INDEX_CLEANED_UP, FTS_INDEX_STALE, FTS_INDEXES_RESTORED, FTS_INDEXES_RESTORE_FAILED, or FTS_INDEXES_SYNONYM_MAPPING_INVALID.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Host event identifies different activities about mongod host.

  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
  • deskLocation string

    Desk location of MongoDB employee associated with the event.

  • employeeIdentifier string

    Identifier of MongoDB employee associated with the event.

  • eventTypeName string Required

    Unique identifier of event type.

    Values are ATTEMPT_KILLOP_AUDIT, ATTEMPT_KILLSESSION_AUDIT, HOST_UP, HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_RECOVERED_OOM, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_RESUME_REPLICATION, HOST_MONGOT_STOP_REPLICATION, HOST_MONGOT_UNPAUSE_INITIAL_SYNC, HOST_MONGOT_PAUSE_INITIAL_SYNC, HOST_MONGOT_SUFFICIENT_DISK_SPACE, HOST_MONGOT_APPROACHING_STOP_REPLICATION, HOST_SEARCH_NODE_UNBLOCKED, HOST_SEARCH_NODE_INDEX_FAILED, HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN, HOST_EXTERNAL_LOG_SINK_EXPORT_RESUMED, HOST_ENOUGH_DISK_SPACE, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, SSH_KEY_NDS_HOST_ACCESS_ATTEMPT, SSH_KEY_NDS_HOST_ACCESS_GRANTED, SSH_KEY_NDS_HOST_ACCESS_LEVEL_CHANGED, ALERT_HOST_SSH_SESSION_STARTED, HOST_SSH_SESSION_ENDED, HOST_X509_CERTIFICATE_CERTIFICATE_GENERATED_FOR_SUPPORT_ACCESS, PUSH_BASED_LOG_EXPORT_RESUMED, PUSH_BASED_LOG_EXPORT_STOPPED, PUSH_BASED_LOG_EXPORT_DROPPED_LOG, HOST_VERSION_BEHIND, VERSION_BEHIND, HOST_EXPOSED, HOST_SSL_CERTIFICATE_STALE, or HOST_SECURITY_CHECKUP_NOT_MET.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • port integer(int32)

    IANA port on which the MongoDB process listens for requests.

  • 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}$.

  • replicaSetName string

    Human-readable label of the replica set associated with the event.

  • shardName string

    Human-readable label of the shard associated with the event.

  • 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.

  Host Metric Event reflects different measurements and metrics about mongod host.

  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
  • currentValue object

    Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.

    Hide currentValue attributes Show currentValue attributes object

    • number number(double)

      Amount of the metricName recorded at the time of the event. This value triggered the alert.

    • units string

      Element used to express the quantity in currentValue.number. This can be an element of time, storage capacity, and the like. This metric triggered the alert.

      Values are bits, Kbits, Mbits, Gbits, bytes, KB, MB, GB, TB, PB, nsec, msec, sec, min, hours, million minutes, days, requests, 1000 requests, tokens, million tokens, pixels, billion pixels, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.

  • deskLocation string

    Desk location of MongoDB employee associated with the event.

  • employeeIdentifier string

    Identifier of MongoDB employee associated with the event.

  • eventTypeName string Required

    Unique identifier of event type.

    Values are INSIDE_METRIC_THRESHOLD or OUTSIDE_METRIC_THRESHOLD.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • metricName string Discriminator

    Human-readable label of the metric associated with the alertId. This field may change type of currentValue field.

    Value is HostMetricEvent.

  • 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})$.

  • port integer(int32)

    IANA port on which the MongoDB process listens for requests.

  • 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}$.

  • replicaSetName string

    Human-readable label of the replica set associated with the event.

  • shardName string

    Human-readable label of the shard associated with the event.

  • 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.

  Audit saving information about Atlas cloud provider and other Atlas related details.

  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
  • dbUserUsername string

    The username of the MongoDB User that was created, deleted, or edited.

  • eventTypeName string Required

    Unique identifier of event type.

    Values are CLUSTER_CREATED, CLUSTER_RESURRECTED, CLUSTER_READY, CLUSTER_UPDATE_SUBMITTED, CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED, CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED, CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED, CLUSTER_AUTOMATICALLY_PAUSED, CLUSTER_UPDATE_STARTED, CLUSTER_UPDATE_STARTED_INTERNAL, CLUSTER_UPDATE_COMPLETED, MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL, CLUSTER_DELETE_SUBMITTED, CLUSTER_DELETE_SUBMITTED_INTERNAL, CLUSTER_DELETED, CLUSTER_IMPORT_STARTED, CLUSTER_IMPORT_CANCELLED, CLUSTER_IMPORT_EXPIRED, CLUSTER_IMPORT_CUTOVER, CLUSTER_IMPORT_COMPLETED, CLUSTER_IMPORT_FAILED, CLUSTER_IMPORT_RESTART_REQUESTED, PROJECT_LIVE_IMPORT_OVERRIDES_ADDED, PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED, PROJECT_LIVE_IMPORT_OVERRIDES_DELETED, CLUSTER_OPLOG_RESIZED, CLUSTER_INSTANCE_RESTARTED, CLUSTER_INSTANCE_STOP_START, CLUSTER_INSTANCE_RESYNC_REQUESTED, CLUSTER_INSTANCE_RESYNC_CLEARED, CLUSTER_INSTANCE_UPDATE_REQUESTED, CLUSTER_INSTANCE_REPLACED, CLUSTER_INSTANCE_REPLACE_CLEARED, CLUSTER_INSTANCE_SWAPPED, CLUSTER_INSTANCE_SWAP_CLEARED, CLUSTER_INSTANCE_VM_RESTART_CLEARED, CLUSTER_INSTANCE_VM_REBOOT_CLEARED, CLUSTER_INSTANCE_CONFIG_UPDATED, CLUSTER_INSTANCE_AGENT_API_KEY_ROTATED, CLUSTER_INSTANCE_SSL_ROTATED, CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER, CLUSTER_INSTANCE_SSL_REVOKED, RELOAD_SSL_ON_PROCESSES, RELOAD_SSL_ON_PROCESSES_REQUESTED, CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED, DATA_LAKE_QUERY_LOGS_DOWNLOADED, FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED, ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED, MONGODB_LOGS_DOWNLOADED, MONGOSQLD_LOGS_DOWNLOADED, MONGOT_LOGS_DOWNLOADED, MONGODB_USER_ADDED, MONGODB_USER_DELETED, MONGODB_USER_X509_CERT_CREATED, MONGODB_USER_X509_CERT_REVOKED, MONGODB_USER_UPDATED, MONGODB_ROLE_ADDED, MONGODB_ROLE_DELETED, MONGODB_ROLE_UPDATED, NETWORK_PERMISSION_ENTRY_ADDED, NETWORK_PERMISSION_ENTRY_REMOVED, NETWORK_PERMISSION_ENTRY_UPDATED, PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED, PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED, PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED, PLAN_STARTED, PLAN_COMPLETED, PLAN_ABANDONED, PLAN_DECLINED, PLAN_FAILURE_COUNT_RESET, PLAN_ASAP_REQUESTED, INDEPENDENT_SHARD_AUTO_SCALING_AVAILABLE, INDEPENDENT_SHARD_SCALING_CLUSTER_MIGRATED, INDEPENDENT_SHARD_SCALING_CLUSTER_ROLLED_BACK, MOVE_SKIPPED, STEP_SKIPPED, PROXY_RESTARTED, PROXY_PANICKED, ATLAS_MAINTENANCE_PROTECTED_HOURS_CREATED, ATLAS_MAINTENANCE_PROTECTED_HOURS_MODIFIED, ATLAS_MAINTENANCE_PROTECTED_HOURS_REMOVED, ATLAS_MAINTENANCE_WINDOW_ADDED, ATLAS_MAINTENANCE_WINDOW_MODIFIED, ATLAS_MAINTENANCE_WINDOW_REMOVED, ATLAS_MAINTENANCE_START_ASAP, ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW, ATLAS_MAINTENANCE_DEFERRED, ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED, ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED, ATLAS_MAINTENANCE_RESET_BY_ADMIN, ATLAS_MAINTENANCE_DEFERRED_BY_ADMIN, SCHEDULED_MAINTENANCE, PROJECT_SCHEDULED_MAINTENANCE, PROJECT_LIMIT_UPDATED, PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED, OS_MAINTENANCE, OS_MAINTENANCE_RESTART, OS_MAINTENANCE_REPLACEMENT, FREE_UPGRADE_STARTED, FLEX_UPGRADE_STARTED, SERVERLESS_UPGRADE_STARTED, TEST_FAILOVER_REQUESTED, USER_SECURITY_SETTINGS_UPDATED, AUDIT_LOG_CONFIGURATION_UPDATED, STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED, ENCRYPTION_AT_REST_CONFIGURATION_UPDATED, ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED, ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_SUCCEEDED, NDS_SET_IMAGE_OVERRIDES, NDS_SET_CHEF_TARBALL_URI, RESTRICTED_EMPLOYEE_ACCESS_BYPASS, REVOKED_EMPLOYEE_ACCESS_BYPASS, DEVICE_SYNC_DEBUG_ACCESS_GRANTED, DEVICE_SYNC_DEBUG_ACCESS_REVOKED, DEVICE_SYNC_DEBUG_X509_CERT_CREATED, EMPLOYEE_ACCESS_GRANTED, EMPLOYEE_ACCESS_REVOKED, QUERY_ENGINE_TENANT_CREATED, QUERY_ENGINE_TENANT_UPDATED, QUERY_ENGINE_TENANT_REMOVED, FEDERATED_DATABASE_CREATED, FEDERATED_DATABASE_UPDATED, FEDERATED_DATABASE_REMOVED, TENANT_SNAPSHOT_FAILED, TENANT_RESTORE_FAILED, SAMPLE_DATASET_LOAD_REQUESTED, CUSTOMER_X509_CRL_UPDATED, CONTAINER_SUBNETS_UPDATE_REQUESTED, ONLINE_ARCHIVE_CREATED, ONLINE_ARCHIVE_DELETED, ONLINE_ARCHIVE_UPDATED, ONLINE_ARCHIVE_PAUSE_REQUESTED, ONLINE_ARCHIVE_PAUSED, ONLINE_ARCHIVE_ACTIVE, ONLINE_ARCHIVE_ORPHANED, ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED, ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED, ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED, ONLINE_ARCHIVE_DELETE_AFTER_DATE_UPDATED, CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED, CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED, CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED, CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED, CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED, CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED, CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_ADDED, CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_DELETED, CLOUD_PROVIDER_ACCESS_GCP_SERVICE_ACCOUNT_UPDATED, PENDING_INDEXES_DELETED, PENDING_INDEXES_CANCELED, PROCESS_RESTART_REQUESTED, AUTO_HEALING_ACTION, AUTO_HEALING_REQUESTED_CRITICAL_INSTANCE_POWER_CYCLE, AUTO_HEALING_REQUESTED_INSTANCE_REPLACEMENT, AUTO_HEALING_REQUESTED_NODE_RESYNC, EXTRA_MAINTENANCE_DEFERRAL_GRANTED, GROUP_AUTOMATION_CONFIG_PUBLISHED, CLUSTER_AUTOMATION_CONFIG_PUBLISHED, SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER, CLUSTER_LINKED_TO_VERCEL, CLUSTER_UNLINKED_FROM_VERCEL, INGESTION_PIPELINE_DELETED, INGESTION_PIPELINE_DESTROYED, INGESTION_PIPELINE_CREATED, INGESTION_PIPELINE_UPDATED, OS_TUNE_FILE_OVERRIDES, MONITORING_AGENT_OVERRIDES, MONITORING_AGENT_REBALANCE_FLAG, MONITORING_AGENT_REBALANCE_TRIGGERED, CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED, CLUSTER_FORCE_PLANNED, CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED, CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START, CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED, CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED, CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE, UIS_PANICKED, TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL, TENANT_UPGRADE_TO_SERVERLESS_FAILED, SERVERLESS_UPGRADE_TO_DEDICATED_SUCCESSFUL, SERVERLESS_UPGRADE_TO_DEDICATED_FAILED, CLUSTER_FORCE_RECONFIG_REQUESTED, PROJECT_BYPASSED_MAINTENANCE, FEATURE_FLAG_MAINTENANCE, DATA_FEDERATION_QUERY_LIMIT_CONFIGURED, DATA_FEDERATION_QUERY_LIMIT_DELETED, DATA_API_SETUP_FOR_VERCEL, ADMIN_CLUSTER_LOCK_UPDATED, CLUSTER_ROLLING_RESYNC_STARTED, CLUSTER_ROLLING_RESYNC_COMPLETED, CLUSTER_ROLLING_RESYNC_FAILED, NODE_ROLLING_RESYNC_SCHEDULED, CLUSTER_ROLLING_RESYNC_CANCELED, CLUSTER_OS_UPDATED, CLUSTER_INSTANCE_FAMILY_UPDATED, PUSH_BASED_LOG_EXPORT_ENABLED, PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED, PUSH_BASED_LOG_EXPORT_DISABLED, LOG_STREAMING_ENABLED, LOG_STREAMING_CONFIGURATION_UPDATED, LOG_STREAMING_DISABLED, DATADOG_LOG_STREAMING_ENABLED, DATADOG_LOG_STREAMING_CONFIGURATION_UPDATED, DATADOG_LOG_STREAMING_DISABLED, SPLUNK_LOG_STREAMING_ENABLED, SPLUNK_LOG_STREAMING_CONFIGURATION_UPDATED, SPLUNK_LOG_STREAMING_DISABLED, S3_LOG_STREAMING_ENABLED, S3_LOG_STREAMING_CONFIGURATION_UPDATED, S3_LOG_STREAMING_DISABLED, AZURE_LOG_STREAMING_ENABLED, AZURE_LOG_STREAMING_CONFIGURATION_UPDATED, AZURE_LOG_STREAMING_DISABLED, GCP_LOG_STREAMING_ENABLED, GCP_LOG_STREAMING_CONFIGURATION_UPDATED, GCP_LOG_STREAMING_DISABLED, OTEL_LOG_STREAMING_ENABLED, OTEL_LOG_STREAMING_CONFIGURATION_UPDATED, OTEL_LOG_STREAMING_DISABLED, AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED, CONTAINER_DELETED, REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED, REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED, STREAM_TENANT_CREATED, STREAM_TENANT_UPDATED, STREAM_TENANT_DELETED, STREAM_TENANT_CONNECTIONS_LISTED, STREAM_TENANT_CONNECTION_UPDATED, STREAM_TENANT_CONNECTION_DELETED, STREAM_TENANT_CONNECTION_CREATED, STREAM_TENANT_CONNECTION_VIEWED, STREAM_TENANT_OPERATIONAL_LOGS, STREAM_TENANT_AUDIT_LOGS, STREAM_TENANT_AUDIT_LOGS_DELETED, QUEUED_ADMIN_ACTION_CREATED, QUEUED_ADMIN_ACTION_COMPLETED, QUEUED_ADMIN_ACTION_CANCELLED, ATLAS_SQL_SCHEDULED_UPDATE_CREATED, ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED, ATLAS_SQL_SCHEDULED_UPDATE_REMOVED, CLUSTER_INSTANCE_DISABLED, CLUSTER_INSTANCE_ENABLED, CLUSTER_BLOCK_WRITE, CLUSTER_UNBLOCK_WRITE, KMIP_KEY_ROTATION_SCHEDULED, SSL_CERTIFICATE_ISSUED, PROJECT_SCHEDULED_MAINTENANCE_OUTSIDE_OF_PROTECTED_HOURS, CLUSTER_CANCELING_SHARD_DRAIN_REQUESTED, CLUSTER_CANCELING_CONFIG_SERVER_TRANSITION_REQUESTED, CLUSTER_MIGRATE_BACK_TO_AWS_MANAGED_IP_REQUESTED, CLUSTER_IP_MIGRATED_FIRST_ROUND, CLUSTER_IP_MIGRATED_SECOND_ROUND, CLUSTER_IP_MIGRATED_FINAL_ROUND, CLUSTER_IP_ROLLED_BACK, AZ_BALANCING_OVERRIDE_MODIFIED, FTDC_SETTINGS_UPDATED, PROXY_PROTOCOL_FOR_PRIVATE_LINK_MODE_UPDATED, MONGOTUNE_WRITE_BLOCK_POLICY_ELIGIBLE, MONGOTUNE_WRITE_BLOCK_POLICY_INELIGIBLE, PREDICTIVE_AUTOSCALING_ENABLED, PREDICTIVE_AUTOSCALING_DISABLED, SHADOW_CLUSTER_CREATE_EXPOSURE, SHADOW_CLUSTER_DELETE_EXPOSURE, SHADOW_CLUSTER_RECORDING_STATUS_UPDATE, or SHADOW_CLUSTER_REPLAY_STATUS_UPDATE.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  • whitelistEntry string

    Entry in the list of source host addresses that the API key accepts and this event targets.

  Auto scaling audit indicates when Atlas auto-scaling cluster tier up or down.

  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.

    Values are COMPUTE_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_INITIATED, COMPUTE_AUTO_SCALE_INITIATED_BASE, COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL, PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE, PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, or CLUSTER_AUTO_SHARDING_INITIATED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Serverless instance audit identifies any activities around serverless instance.

  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.

    Values are SERVERLESS_INSTANCE_CREATED, SERVERLESS_INSTANCE_READY, SERVERLESS_INSTANCE_UPDATE_SUBMITTED, SERVERLESS_INSTANCE_UPDATE_STARTED, SERVERLESS_INSTANCE_UPDATE_COMPLETED, SERVERLESS_INSTANCE_DELETE_SUBMITTED, SERVERLESS_INSTANCE_DELETED, or SERVERLESS_INSTANCE_UNBLOCKED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Tenant endpoint audit indicates when Atlas auto-scaling cluster tier up or down.

  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
  • endpointId string

    Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.

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

  • eventTypeName string Required

    Unique identifier of event type.

    Values are TENANT_ENDPOINT_CREATED, TENANT_ENDPOINT_RESERVED, TENANT_ENDPOINT_RESERVATION_FAILED, TENANT_ENDPOINT_UPDATED, TENANT_ENDPOINT_INITIATING, TENANT_ENDPOINT_AVAILABLE, TENANT_ENDPOINT_FAILED, TENANT_ENDPOINT_DELETING, TENANT_ENDPOINT_DELETED, or TENANT_ENDPOINT_EXPIRED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • providerEndpointId string

    Unique identification string that the cloud provider uses to identify the private endpoint.

  • 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.

  Replica Set Event identifies different activities about replica set of mongod instances.

  Hide attributes Show attributes

  • 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.

    Values are PRIMARY_ELECTED, REPLICATION_OPLOG_WINDOW_HEALTHY, REPLICATION_OPLOG_WINDOW_RUNNING_OUT, ONE_PRIMARY, NO_PRIMARY, TOO_MANY_ELECTIONS, TOO_FEW_HEALTHY_MEMBERS, or TOO_MANY_UNHEALTHY_MEMBERS.

  • 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})$.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • port integer(int32)

    IANA port on which the MongoDB process listens for requests.

  • 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.

  • replicaSetName string

    Human-readable label of the replica set associated with the event.

  • shardName string

    Human-readable label of the shard associated with the event.

  Indicates activities on decoupled search nodes.

  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.

    Values are SEARCH_DEPLOYMENT_CREATED, SEARCH_DEPLOYMENT_UPDATED, or SEARCH_DEPLOYMENT_DELETED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Team event identifies different activities around organization teams.

  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.

    Values are TEAM_ADDED_TO_GROUP, TEAM_REMOVED_FROM_GROUP, or TEAM_ROLES_MODIFIED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • teamId string

    Unique 24-hexadecimal digit string that identifies the organization team associated with this event.

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

  • 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.

  User event reflects different activities about the atlas user.

  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.

    Values are JOINED_GROUP, REMOVED_FROM_GROUP, INVITED_TO_GROUP, REQUESTED_TO_JOIN_GROUP, GROUP_INVITATION_DELETED, USER_ROLES_CHANGED_AUDIT, JOIN_GROUP_REQUEST_DENIED_AUDIT, or JOIN_GROUP_REQUEST_APPROVED_AUDIT.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • targetUsername string(email)

    Email address for the console user that this event targets. The resource returns this parameter when "eventTypeName" : "USER".

  • 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.

  Resource event reflects different activities about resources.

  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.

    Values are TAGS_MODIFIED, CLUSTER_TAGS_MODIFIED, or GROUP_TAGS_MODIFIED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • resourceId string

    Unique 24-hexadecimal digit string that identifies the resource associated with the event.

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

  • resourceType string Required

    Unique identifier of resource type.

  • 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.

  Streams event identifies different activities about Atlas Streams.

  Hide attributes Show attributes

  • 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.

    Value is MAX_PROCESSOR_COUNT_REACHED.

  • 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})$.

  • instanceName string

    Name of the stream processing workspace associated with the event.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • 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.

  Stream Processor event identifies different activities about a stream processor in Atlas Streams.

  Hide attributes Show attributes

  • 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.

    Values are STREAM_PROCESSOR_STATE_IS_FAILED, INSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD, or OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD.

  • 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})$.

  • instanceName string

    Name of the stream processing workspace associated with the event.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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})$.

  • processorErrorMsg string

    Error message linked to the stream processor associated with the event.

  • processorName string

    Name of the stream processor associated with the event.

  • processorState string

    State of the stream processor associated with the event.

  • 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.

  Audit events related to Atlas Charts.

  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.

    Values are CHARTS_API_SUCCESS or CHARTS_API_FAILURE.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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.

  Atlas resource policy audits indicate organization level changes to resource policies.

  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.

    Value is RESOURCE_POLICY_VIOLATED.

  • 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.

  • links array[object]

    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.

    Web Linking Specification (RFC...
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • 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}$.

  • resourcePolicyId string

    Unique 24-hexadecimal character string that identifies the resource policy.

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

  • 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.

  • violatedPolicies array[string]

    String representation of the violated resource policy ids.

  • violationAction string

    Resource policy action taken by the user and evaluated against the currently active policies.

• 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 headers attributes Show headers attributes

  • RateLimit-Limit

    The maximum number of requests that a user can make within a specific time window.

  • RateLimit-Remaining

    The number of requests remaining in the current rate limit window before the limit is reached.

  • Retry-After

    The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses.

  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.