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

• clusterName string Required

  Human-readable label that identifies the cluster.

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

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
• authResult boolean

  Flag that indicates whether the response returns the successful authentication attempts only.

• end integer(int64)

  Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses UNIX epoch time in milliseconds.

• ipAddress string

  One Internet Protocol address that attempted to authenticate with the database.

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

• nLogs integer(int32)

  Maximum number of lines from the log to return.

  Minimum value is 0, maximum value is 20000. Default value is 20000.

• start integer(int64)

  Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses UNIX epoch time in milliseconds.

Responses

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

  OK

  Hide response attribute Show response attribute object

  • accessLogs array[object]

    Authentication attempt, one per object, made against the cluster.

    Authentication attempt, one per object, made against the cluster.

    Hide accessLogs attributes Show accessLogs attributes object

    • authResult boolean

      Flag that indicates whether the response should return successful authentication attempts only.

    • authSource string

      Database against which someone attempted to authenticate.

    • failureReason string

      Reason that the authentication failed. Null if authentication succeeded.

    • groupId string

      Unique 24-hexadecimal character string that identifies the project.

    • hostname string

      Human-readable label that identifies the hostname of the target node that received the authentication attempt.

    • ipAddress string

      Internet Protocol address that attempted to authenticate with the database.

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

    • logLine string

      Text of the host log concerning the authentication attempt.

    • timestamp string

      Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.

    • username string

      Username used to authenticate against the database.

• 400 application/json

  Bad Request.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 401 application/json

  Unauthorized.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 403 application/json

  Forbidden.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 404 application/json

  Not Found.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

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

• 429 application/json

  Too Many Requests.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

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

• alertId string Required

  Unique 24-hexadecimal digit string that identifies the alert.

  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

Responses

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

  OK

  One of:

  AppServiceAlertView object ClusterAlertViewForNdsGroup object HostAlertViewForNdsGroup object HostMetricAlert object ReplicaSetAlertViewForNdsGroup object StreamProcessorAlertViewForNdsGroup object DefaultAlertViewForNdsGroup object

  App Services alert notifies different activities about a BAAS application.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601
  • eventTypeName string Required

    Incident that triggered this alert.

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

  • groupId string

    Unique 24-hexadecimal digit string that identifies the project that owns this alert.

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

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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 character string that identifies the organization that owns the project to which this alert applies.

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

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  Cluster alert notifies different activities and conditions about cluster of mongod hosts.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • clusterName string

    Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601
  • eventTypeName string Required

    Event type that triggers an alert.

    Value is CLUSTER_MONGOS_IS_MISSING.

  • groupId string

    Unique 24-hexadecimal digit string that identifies the project that owns this alert.

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

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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 character string that identifies the organization that owns the project to which this alert applies.

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

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  Host alert notifies about activities on mongod host.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • clusterName string

    Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601
  • eventTypeName string Required

    Event type that triggers an alert.

    Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, 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 that owns this alert.

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

  • hostnameAndPort string

    Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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 character string that identifies the organization that owns the project to which this alert applies.

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

  • replicaSetName string

    Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  Host Metric Alert notifies about changes of measurements or metrics for mongod host.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • clusterName string

    Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. 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, GB seconds, GB hours, GB days, RPU, thousand RPU, million RPU, WPU, thousand WPU, million WPU, count, thousand, million, or billion.

  • eventTypeName string Required

    Event type that triggers an alert.

    Value is OUTSIDE_METRIC_THRESHOLD.

  • groupId string

    Unique 24-hexadecimal digit string that identifies the project that owns this alert.

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

  • hostnameAndPort string

    Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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

    Name of the metric against which Atlas checks the configured metricThreshold.threshold.

    To learn more about the available metrics, see Host Metrics.

    NOTE: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.

    Value is HostMetricAlert.

  • orgId string

    Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.

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

  • replicaSetName string

    Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  ReplicaSet alert notifies about different activities on replica set of mongod instances.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • clusterName string

    Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601
  • eventTypeName string Required

    Incident that triggered this alert.

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

  • groupId string

    Unique 24-hexadecimal digit string that identifies the project that owns this alert.

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

  • hostnameAndPort string

    Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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.

  • nonRunningHostIds array[string]

    List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.

    Format of each should match the following pattern: ^([a-f0-9]{8,32})$.

  • orgId string

    Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.

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

  • parentClusterId string

    Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.

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

  • replicaSetName string

    Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601
  • eventTypeName string Required

    Event type that triggers an alert.

    Values are HOST_DOWN, HOST_HAS_INDEX_SUGGESTIONS, HOST_MONGOT_CRASHING_OOM, HOST_MONGOT_STOP_REPLICATION, HOST_NOT_ENOUGH_DISK_SPACE, SSH_KEY_NDS_HOST_ACCESS_REQUESTED, SSH_KEY_NDS_HOST_ACCESS_REFRESHED, 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 that owns this alert.

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

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • instanceName string

    The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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 character string that identifies the organization that owns the project to which this alert applies.

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

  • processorErrorMsg string

    The error message associated with the Stream Processor to which this alert applies.

  • processorName string

    The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.

  • processorState string

    The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

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

  Hide attributes Show attributes

  • acknowledgedUntil string(date-time)

    Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

    • To acknowledge this alert forever, set the parameter value to 100 years in the future.

    • To unacknowledge a previously acknowledged alert, do not set this parameter value.

    ISO 8601
  • acknowledgementComment string

    Comment that a MongoDB Cloud user submitted when acknowledging the alert.

    Maximum length is 200.

  • acknowledgingUsername string(email)

    MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.

  • alertConfigId string Required

    Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.

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

  • created string(date-time) Required

    Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    ISO 8601

  • eventTypeName string Required

    Incident that triggered this alert.

    One of:

    Billing Event Types string Cps Backup Event Types string Encryption Event Types string FTS Index Audit Types string Group Event Types string NDS Audit Types string NDS Maintenance Window Audit Types string NDS x509 User Auth Event Types string Online Archive Event Types string Serverless Event Types string Flex Metric Event Types string User Event Types string Resource Event Types string Stream Processor Event Types string NDS Auto Scaling Audit Types string Data Protection Event Types string Atlas Resource Policy Audit Types string

    Values are CREDIT_CARD_ABOUT_TO_EXPIRE, PENDING_INVOICE_OVER_THRESHOLD, or DAILY_BILL_OVER_THRESHOLD.

    Values are CPS_SNAPSHOT_STARTED, CPS_SNAPSHOT_SUCCESSFUL, CPS_SNAPSHOT_FAILED, CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY, 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_SUCCESSFUL, CPS_SNAPSHOT_FALLBACK_FAILED, CPS_RESTORE_SUCCESSFUL, CPS_EXPORT_SUCCESSFUL, CPS_RESTORE_FAILED, CPS_EXPORT_FAILED, CPS_AUTO_EXPORT_FAILED, CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED, CPS_OPLOG_BEHIND, or CPS_OPLOG_CAUGHT_UP.

    Values are AWS_ENCRYPTION_KEY_NEEDS_ROTATION, AZURE_ENCRYPTION_KEY_NEEDS_ROTATION, GCP_ENCRYPTION_KEY_NEEDS_ROTATION, AWS_ENCRYPTION_KEY_INVALID, AZURE_ENCRYPTION_KEY_INVALID, or GCP_ENCRYPTION_KEY_INVALID.

    Values are FTS_INDEX_DELETION_FAILED, FTS_INDEX_BUILD_COMPLETE, FTS_INDEX_BUILD_FAILED, FTS_INDEXES_RESTORE_FAILED, or FTS_INDEXES_SYNONYM_MAPPING_INVALID.

    Values are USERS_WITHOUT_MULTI_FACTOR_AUTH, ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED, or ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID.

    Values are CLUSTER_INSTANCE_STOP_START, CLUSTER_INSTANCE_RESYNC_REQUESTED, CLUSTER_INSTANCE_UPDATE_REQUESTED, SAMPLE_DATASET_LOAD_REQUESTED, TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL, TENANT_UPGRADE_TO_SERVERLESS_FAILED, NETWORK_PERMISSION_ENTRY_ADDED, NETWORK_PERMISSION_ENTRY_REMOVED, NETWORK_PERMISSION_ENTRY_UPDATED, CLUSTER_BLOCK_WRITE, or CLUSTER_UNBLOCK_WRITE.

    Values are MAINTENANCE_IN_ADVANCED, MAINTENANCE_AUTO_DEFERRED, MAINTENANCE_STARTED, or MAINTENANCE_NO_LONGER_NEEDED.

    Values are NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK, NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK, or NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK.

    Values are ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK or ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK.

    Value is OUTSIDE_SERVERLESS_METRIC_THRESHOLD.

    Value is OUTSIDE_FLEX_METRIC_THRESHOLD.

    Values are JOINED_GROUP, REMOVED_FROM_GROUP, or USER_ROLES_CHANGED_AUDIT.

    Values are TAGS_MODIFIED, CLUSTER_TAGS_MODIFIED, or GROUP_TAGS_MODIFIED.

    Values are STREAM_PROCESSOR_STATE_IS_FAILED or OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD.

    Values are 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_INITIATED, 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, or PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE.

    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.

    Value is RESOURCE_POLICY_VIOLATED.

  • groupId string

    Unique 24-hexadecimal digit string that identifies the project that owns this alert.

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

  • id string Required

    Unique 24-hexadecimal digit string that identifies this alert.

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

  • lastNotified string(date-time)

    Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.

    ISO 8601
  • 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 5988)
    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 character string that identifies the organization that owns the project to which this alert applies.

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

  • resolved string(date-time)

    Date and time that this alert changed to "status" : "CLOSED". This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once "status" : "CLOSED".

    ISO 8601
  • status string Required

    State of this alert at the time you requested its details.

    Values are CANCELLED, CLOSED, OPEN, or TRACKING.

  • updated string(date-time) Required

    Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

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

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

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

• clusterName string Required

  Name of the cluster that contains the database and collection with one or more Application Search indexes.

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

• indexId string Required

  Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.

  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

Responses

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

  This endpoint does not return a response body.

• 400 application/json

  Bad Request.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 401 application/json

  Unauthorized.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 403 application/json

  Forbidden.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 404 application/json

  Not Found.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

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

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

• clusterName string Required

  Name of the cluster that contains the collection with one or more Atlas Search indexes.

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

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

Responses

• 200 application/vnd.atlas.2024-05-30+json

  OK

  One of:

  search object vectorSearch object

  Hide attributes Show attributes

  • collectionName string

    Label that identifies the collection that contains one or more Atlas Search indexes.

  • database string

    Label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • indexID string

    Unique 24-hexadecimal digit string that identifies this Atlas Search index.

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

  • latestDefinition object

    The text search index definition set by the user.

    Hide latestDefinition attributes Show latestDefinition attributes object

    • numPartitions integer(int32)

      Number of index partitions. Allowed values are [1, 2, 4].

      Default value is 1.

    • analyzer string

      Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves making the following changes to the text in fields:

      • extracting words
      • removing punctuation
      • removing accents
      • changing to lowercase
      • removing common words
      • reducing words to their root form (stemming)
      • changing words to their base form (lemmatization) MongoDB Cloud uses the process you select to build the Atlas Search index.

      Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

      Atlas Search Analyzers
    • analyzers array[object]

      List of user-defined methods to convert database field text into searchable words.

      Custom Atlas Search Analyzers
      Hide analyzers attributes Show analyzers attributes object

      • charFilters array[object]

        Filters that examine text one character at a time and perform filtering operations.

        Hide charFilters attribute Show charFilters attribute object

        • * object Additional properties
      • name string Required

        Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:

        • lucene.
        • builtin.
        • mongodb.
      • tokenFilters array[object]

        Filter that performs operations such as:

        • Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

        • Redaction, which is the removal of sensitive information from public documents.

        Hide tokenFilters attribute Show tokenFilters attribute object

        • * object Additional properties
      • tokenizer object Required

        Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

        Hide tokenizer attribute Show tokenizer attribute object

        • * object Additional properties

          Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

    • mappings object Required

      Index specifications for the collection's fields.

      Hide mappings attributes Show mappings attributes object

      • dynamic boolean

        Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.

        Dynamic or Static Mappings
      • fields object

        One or more field specifications for the Atlas Search index. Required if mappings.dynamic is omitted or set to false.

        Atlas Search Index
        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Atlas Search Field Mappings
    • searchAnalyzer string

      Method applied to identify words when searching this index.

      Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian. Default value is lucene.standard.

    • storedSource object

      Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.

      Stored Source Fields
    • synonyms array[object]

      Rule sets that map words to their synonyms in this index.

      Synonyms used for this full text index.

      Synonym Mapping
      Hide synonyms attributes Show synonyms attributes object

      • analyzer string Required

        Specific pre-defined method chosen to apply to the synonyms to be searched.

        Values are lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, or lucene.ukrainian.

      • name string Required

        Label that identifies the synonym definition. Each synonym.name must be unique within the same index definition.

      • source object Required

        Data set that stores words and their applicable synonyms.

        Hide source attribute Show source attribute object

        • collection string Required

          Label that identifies the MongoDB collection that stores words and their applicable synonyms.

  • latestDefinitionVersion object

    Object which includes the version number of the index definition and the time that the index definition was created.

    Hide latestDefinitionVersion attributes Show latestDefinitionVersion attributes object

    • createdAt string(date-time)

      The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • version integer(int64)

      The version number associated with this index definition when it was created.

  • name string

    Label that identifies this index. Within each namespace, the names of all indexes must be unique.

  • queryable boolean

    Flag that indicates whether the index is queryable on all hosts.

  • status string

    Condition of the search index when you made this request.

    • DELETING: The index is being deleted.
    • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
    • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
    • PENDING: Atlas has not yet started building the index.
    • BUILDING: Atlas is building or re-building the index after an edit.
    • READY: The index is ready and can support queries.

    Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • statusDetail array[object]

    List of documents detailing index status on each host.

    Hide statusDetail attributes Show statusDetail attributes object

    • hostname string

      Hostname that corresponds to the status detail.

    • mainIndex object

      Contains status information about the active index.

      Hide mainIndex attributes Show mainIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • queryable boolean

      Flag that indicates whether the index is queryable on the host.

    • stagedIndex object

      Contains status information about an index building in the background.

      Hide stagedIndex attributes Show stagedIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • status string

      Condition of the search index when you made this request.

      • DELETING: The index is being deleted.
      • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
      • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
      • PENDING: Atlas has not yet started building the index.
      • BUILDING: Atlas is building or re-building the index after an edit.
      • READY: The index is ready and can support queries.

      Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • type string Discriminator

    Type of the index. The default type is search.

    Value is search.

  • synonymMappingStatus string

    Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.

    Values are FAILED, BUILDING, or READY.

  • synonymMappingStatusDetail array[object]

    A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.

    Hide synonymMappingStatusDetail attribute Show synonymMappingStatusDetail attribute object

    • * object Additional properties

      Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.

      Hide * attributes Show * attributes object

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the synonym mapping is queryable on a host.

      • status string

        Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.

        Values are FAILED, BUILDING, or READY.

  Hide attributes Show attributes

  • collectionName string

    Label that identifies the collection that contains one or more Atlas Search indexes.

  • database string

    Label that identifies the database that contains the collection with one or more Atlas Search indexes.

  • indexID string

    Unique 24-hexadecimal digit string that identifies this Atlas Search index.

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

  • latestDefinition object

    The vector search index definition set by the user.

    Hide latestDefinition attributes Show latestDefinition attributes object

    • numPartitions integer(int32)

      Number of index partitions. Allowed values are [1, 2, 4].

      Default value is 1.

    • fields array[object]

      Settings that configure the fields, one per object, to index. You must define at least one "vector" type field. You can optionally define "filter" type fields also.

      Vector Search Fields
      Hide fields attribute Show fields attribute object

      • * object Additional properties
  • latestDefinitionVersion object

    Object which includes the version number of the index definition and the time that the index definition was created.

    Hide latestDefinitionVersion attributes Show latestDefinitionVersion attributes object

    • createdAt string(date-time)

      The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • version integer(int64)

      The version number associated with this index definition when it was created.

  • name string

    Label that identifies this index. Within each namespace, the names of all indexes must be unique.

  • queryable boolean

    Flag that indicates whether the index is queryable on all hosts.

  • status string

    Condition of the search index when you made this request.

    • DELETING: The index is being deleted.
    • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
    • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
    • PENDING: Atlas has not yet started building the index.
    • BUILDING: Atlas is building or re-building the index after an edit.
    • READY: The index is ready and can support queries.

    Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • statusDetail array[object]

    List of documents detailing index status on each host.

    Hide statusDetail attributes Show statusDetail attributes object

    • hostname string

      Hostname that corresponds to the status detail.

    • mainIndex object

      Contains status information about the active index.

      Hide mainIndex attributes Show mainIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • queryable boolean

      Flag that indicates whether the index is queryable on the host.

    • stagedIndex object

      Contains status information about an index building in the background.

      Hide stagedIndex attributes Show stagedIndex attributes object

      • definition object

        The search index definition set by the user.

        Hide definition attribute Show definition attribute object

        • numPartitions integer(int32)

          Number of index partitions. Allowed values are [1, 2, 4].

          Default value is 1.

      • definitionVersion object

        Object which includes the version number of the index definition and the time that the index definition was created.

        Hide definitionVersion attributes Show definitionVersion attributes object

        • createdAt string(date-time)

          The time at which this index definition was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

        • version integer(int64)

          The version number associated with this index definition when it was created.

      • message string

        Optional message describing an error.

      • queryable boolean

        Flag that indicates whether the index generation is queryable on the host.

      • status string

        Condition of the search index when you made this request.

        • DELETING: The index is being deleted.
        • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
        • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
        • PENDING: Atlas has not yet started building the index.
        • BUILDING: Atlas is building or re-building the index after an edit.
        • READY: The index is ready and can support queries.

        Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

    • status string

      Condition of the search index when you made this request.

      • DELETING: The index is being deleted.
      • FAILED The index build failed. Indexes can enter the FAILED state due to an invalid index definition.
      • STALE: The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data.
      • PENDING: Atlas has not yet started building the index.
      • BUILDING: Atlas is building or re-building the index after an edit.
      • READY: The index is ready and can support queries.

      Values are DELETING, FAILED, STALE, PENDING, BUILDING, READY, or DOES_NOT_EXIST.

  • type string Discriminator

    Type of the index. The default type is search.

    Value is vectorSearch.

• 400 application/json

  Bad Request.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 401 application/json

  Unauthorized.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 403 application/json

  Forbidden.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 404 application/json

  Not Found.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

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

  • detail string

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

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

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

• 503 application/vnd.atlas.2024-05-30+json

  Service Unavailable.

  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.