Return One MongoDB Cloud User by Username | Andrea Test API documentation

Remove One Alert Configuration from One Project

DELETE /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}

Removes one alert configuration from the specified project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.

This resource remains under revision and may change.

Return All Alert Configurations for One Project

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

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

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

No Content
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.

DELETE /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}

atlas api deleteAlertConfiguration --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeleteAlertConfigurationApiParams{}
	httpResp, err := client.AlertConfigurationsApi.
		DeleteAlertConfigurationWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}"

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Acknowledge One Alert from One Project

PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId}

Service accounts Digest auth

Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.

This resource remains under revision and may change. Deprecated versions: v2-{2023-01-01}

Return All Alerts from One Project

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

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

Body Required

Acknowledges or unacknowledges one alert.

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.

ISO 8601
acknowledgementComment string

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

Maximum length is 200.
unacknowledgeAlert boolean

Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter.

Responses

200 application/vnd.atlas.2024-05-30+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

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.

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

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

PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId}

atlas api acknowledgeAlert --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.AcknowledgeAlertApiParams{}
	sdkResp, httpResp, err := client.AlertsApi.
		AcknowledgeAlertWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
  -d '{ <Payload> }'

Request examples

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "unacknowledgeAlert": true
}

Response examples (200)

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "DEPLOYMENT_FAILURE",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CLUSTER_MONGOS_IS_MISSING",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "HOST_DOWN",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "currentValue": {
    "number": 42.0,
    "units": "bits"
  },
  "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "metricName": "ASSERT_USER",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "NO_PRIMARY",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "nonRunningHostIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "parentClusterId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "HOST_DOWN",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "instanceName": "foobar",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "processorErrorMsg": "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)",
  "processorName": "foobar",
  "processorState": "STARTED",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Create One Atlas Search Index Deprecated

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes

Service accounts Digest auth

Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.

Atlas Search Indexes

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 on which to create an Atlas Search index.

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

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

Body object Required

Creates one Atlas Search index on the specified collection.

collectionName string Required

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
database string Required

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.
name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.
numPartitions integer(int32)

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

Default value is 1.
type string Discriminator

Type of the index. Default type is search.

Value is search.
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 a variety of changes made 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 selected process 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.

Settings that describe one Atlas Search custom analyzer.

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.
  One of:
  charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object
  
  Filter that strips out HTML constructs.
  
  Hide attributes Show attributes
  
  ignoredTags array[string]
  
  The HTML tags that you want to exclude from filtering.
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is htmlStrip.
  
  Filter that applies normalization mappings that you specify to characters.
  
  Hide attributes Show attributes
  
  mappings object Required
  
  Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:
  
  <original> : <replacement>.
  
  Hide mappings attribute Show mappings attribute object
  
  * string Additional properties
  
  type string Required
  
  Human-readable label that identifies this character filter type.
  
  Value is mapping.
- name string Required
  Human-readable 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, the removal of sensitive information from public documents.
  Any of:
  tokenFilterasciiFolding object tokenFilterdaitchMokotoffSoundex object tokenFilteredgeGram object TokenFilterEnglishPossessive object TokenFilterFlattenGraph object tokenFiltericuFolding object tokenFiltericuNormalizer object TokenFilterkStemming object tokenFilterlength object tokenFilterlowercase object tokenFilternGram object TokenFilterPorterStemming object tokenFilterregex object tokenFilterreverse object tokenFiltershingle object tokenFiltersnowballStemming object TokenFilterSpanishPluralStemming object TokenFilterStempel object tokenFilterstopword object tokenFiltertrim object TokenFilterWordDelimiterGraph object
  
  Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.
  
  Hide attributes Show attributes
  
  originalTokens string
  
  Value that indicates whether to include or omit the original tokens in the output of the token filter.
  
  Choose include if you want to support queries on both the original tokens as well as the converted forms.
  
  Choose omit if you want to query only on the converted forms of the original tokens.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is asciiFolding.
  
  Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.
  
  NOTE: Don't use the daitchMokotoffSoundex token filter in:
  
  -Synonym or autocomplete mapping definitions
  
  Operators where fuzzy is enabled. Atlas Search supports the fuzzy option only for the autocomplete, term, and text operators.
  
  Hide attributes Show attributes
  
  originalTokens string
  
  Value that indicates whether to include or omit the original tokens in the output of the token filter.
  
  Choose include if you want to support queries on both the original tokens as well as the converted forms.
  
  Choose omit if you want to query only on the converted forms of the original tokens.
  
  Values are omit or include. Default value is include.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is daitchMokotoffSoundex.
  
  Filter that tokenizes input from the left side, or "edge", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  termNotInBounds string
  
  Value that indicates whether to index tokens shorter than minGram or longer than maxGram.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is edgeGram.
  
  Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.
  
  Hide attribute Show attribute
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is flattenGraph.
  
  Filter that normalizes tokens using a standard Unicode Normalization Mode.
  
  Hide attributes Show attributes
  
  normalizationForm string
  
  Normalization form to apply.
  
  Values are nfd, nfc, nfkd, or nfkc. Default value is nfc.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is icuNormalizer.
  
  Filter that removes tokens that are too short or too long.
  
  Hide attributes Show attributes
  
  max integer
  
  Number that specifies the maximum length of a token. Value must be greater than or equal to min.
  
  Default value is 255.
  
  min integer
  
  Number that specifies the minimum length of a token. This value must be less than or equal to max.
  
  Default value is 0.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is length.
  
  Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.
  
  minGram integer Required
  
  Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.
  
  termNotInBounds string
  
  Value that indicates whether to index tokens shorter than minGram or longer than maxGram.
  
  Values are omit or include. Default value is omit.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is nGram.
  
  Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.
  
  Hide attribute Show attribute
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is porterStemming.
  
  Filter that applies a regular expression to each token, replacing matches with a specified string.
  
  Hide attributes Show attributes
  
  matches string Required
  
  Value that indicates whether to replace only the first matching pattern or all matching patterns.
  
  Values are all or first.
  
  pattern string Required
  
  Regular expression pattern to apply to each token.
  
  replacement string Required
  
  Replacement string to substitute wherever a matching pattern occurs.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is regex.
  
  Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxShingleSize integer Required
  
  Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to minShingleSize.
  
  minShingleSize integer Required
  
  Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to maxShingleSize.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is shingle.
  
  Filter that stems tokens using a Snowball-generated stemmer.
  
  Hide attributes Show attributes
  
  stemmerName string Required
  
  Snowball-generated stemmer to use.
  
  Values are arabic, armenian, basque, catalan, danish, dutch, english, finnish, french, german, german2, hungarian, irish, italian, kp, lithuanian, lovins, norwegian, porter, portuguese, romanian, russian, spanish, swedish, or turkish.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is snowballStemming.
  
  Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.
  
  Hide attributes Show attributes
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove.
  
  Default value is true.
  
  tokens array[string] Required
  
  The stop words that correspond to the tokens to remove. Value must be one or more stop words.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is stopword.
  
  Filter that splits tokens into sub-tokens based on configured rules.
  
  Hide attributes Show attributes
  
  delimiterOptions object
  
  Object that contains the rules that determine how to split words into sub-words.
  
  Hide delimiterOptions attributes Show delimiterOptions attributes object
  
  concatenateAll boolean
  
  Flag that indicates whether to concatenate runs.
  
  Default value is false.
  
  concatenateNumbers boolean
  
  Flag that indicates whether to concatenate runs of sub-numbers.
  
  Default value is false.
  
  concatenateWords boolean
  
  Flag that indicates whether to concatenate runs of sub-words.
  
  Default value is false.
  
  generateNumberParts boolean
  
  Flag that indicates whether to split tokens based on sub-numbers. For example, if true, this option splits 100-2 into 100 and 2.
  
  Default value is true.
  
  generateWordParts boolean
  
  Flag that indicates whether to split tokens based on sub-words.
  
  Default value is true.
  
  ignoreKeywords boolean
  
  Flag that indicates whether to skip tokens with the keyword attribute set to true.
  
  Default value is false.
  
  preserveOriginal boolean
  
  Flag that indicates whether to generate tokens of the original words.
  
  Default value is true.
  
  splitOnCaseChange boolean
  
  Flag that indicates whether to split tokens based on letter-case transitions.
  
  Default value is true.
  
  splitOnNumerics boolean
  
  Flag that indicates whether to split tokens based on letter-number transitions.
  
  Default value is true.
  
  stemEnglishPossessive boolean
  
  Flag that indicates whether to remove trailing possessives from each sub-word.
  
  Default value is true.
  
  protectedWords object
  
  Object that contains options for protected words.
  
  Hide protectedWords attributes Show protectedWords attributes object
  
  ignoreCase boolean
  
  Flag that indicates whether to ignore letter case sensitivity for protected words.
  
  Default value is true.
  
  words array[string] Required
  
  List that contains the tokens to protect from delimination.
  
  type string Required
  
  Human-readable label that identifies this token filter type.
  
  Value is wordDelimiterGraph.
- 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.
  
  One of:
  tokenizeredgeGram object tokenizerkeyword object tokenizernGram object tokenizerregexCaptureGroup object tokenizerregexSplit object tokenizerstandard object tokenizeruaxUrlEmail object tokenizerwhitespace object
  
  Tokenizer that splits input from the left side, or "edge", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is edgeGram.
  
  Tokenizer that splits input into text chunks, or "n-grams", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.
  
  Hide attributes Show attributes
  
  maxGram integer Required
  
  Characters to include in the longest token that Atlas Search creates.
  
  minGram integer Required
  
  Characters to include in the shortest token that Atlas Search creates.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is edgeGram.
  
  Tokenizer that uses a regular expression pattern to extract tokens.
  
  Hide attributes Show attributes
  
  group integer Required
  
  Index of the character group within the matching expression to extract into tokens. Use 0 to extract all character groups.
  
  pattern string Required
  
  Regular expression to match against.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexCaptureGroup.
  
  Tokenizer that splits tokens using a regular-expression based delimiter.
  
  Hide attributes Show attributes
  
  pattern string Required
  
  Regular expression to match against.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is regexSplit.
  
  Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is standard.
  
  Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the standard tokenizer to create tokens based on word break rules.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is uaxUrlEmail.
  
  Tokenizer that creates tokens based on occurrences of whitespace between words.
  
  Hide attributes Show attributes
  
  maxTokenLength integer
  
  Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.
  
  Default value is 255.
  
  type string Required Discriminator
  
  Human-readable label that identifies this tokenizer type.
  
  Value is whitespace.
mappings object

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.
  
  Default value is false.
  
  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 documentation.

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.

collectionName string Required

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.
database string Required

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.
name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.
numPartitions integer(int32)

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

Default value is 1.
type string Discriminator

Type of the index. Default type is search.

Value is vectorSearch.
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

Responses

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

OK
One of:
SearchIndex object VectorSearchIndex object
Hide attributes Show attributes

collectionName string Required

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

database string Required

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

numPartitions integer(int32)

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

Default value is 1.

type string Discriminator

Type of the index. Default type is search.

Value is search.

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 a variety of changes made 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 selected process 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.

Settings that describe one Atlas Search custom analyzer.

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.

One of:
charFilterhtmlStrip object charFiltericuNormalize object charFiltermapping object charFilterpersian object

Filter that strips out HTML constructs.

Hide attributes Show attributes

ignoredTags array[string]

The HTML tags that you want to exclude from filtering.

type string Required

Human-readable label that identifies this character filter type.

Value is htmlStrip.

Filter that applies normalization mappings that you specify to characters.

Hide attributes Show attributes

mappings object Required

Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:

<original> : <replacement>.

Hide mappings attribute Show mappings attribute object

* string Additional properties

type string Required

Human-readable label that identifies this character filter type.

Value is mapping.

name string Required

Human-readable 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, the removal of sensitive information from public documents.

Any of:
tokenFilterasciiFolding object tokenFilterdaitchMokotoffSoundex object tokenFilteredgeGram object TokenFilterEnglishPossessive object TokenFilterFlattenGraph object tokenFiltericuFolding object tokenFiltericuNormalizer object TokenFilterkStemming object tokenFilterlength object tokenFilterlowercase object tokenFilternGram object TokenFilterPorterStemming object tokenFilterregex object tokenFilterreverse object tokenFiltershingle object tokenFiltersnowballStemming object TokenFilterSpanishPluralStemming object TokenFilterStempel object tokenFilterstopword object tokenFiltertrim object TokenFilterWordDelimiterGraph object

Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.

Hide attributes Show attributes

originalTokens string

Value that indicates whether to include or omit the original tokens in the output of the token filter.

Choose include if you want to support queries on both the original tokens as well as the converted forms.

Choose omit if you want to query only on the converted forms of the original tokens.

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is asciiFolding.

Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.

NOTE: Don't use the daitchMokotoffSoundex token filter in:

-Synonym or autocomplete mapping definitions

Operators where fuzzy is enabled. Atlas Search supports the fuzzy option only for the autocomplete, term, and text operators.

Hide attributes Show attributes

originalTokens string

Value that indicates whether to include or omit the original tokens in the output of the token filter.

Choose include if you want to support queries on both the original tokens as well as the converted forms.

Choose omit if you want to query only on the converted forms of the original tokens.

Values are omit or include. Default value is include.

type string Required

Human-readable label that identifies this token filter type.

Value is daitchMokotoffSoundex.

Filter that tokenizes input from the left side, or "edge", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.

Hide attributes Show attributes

maxGram integer Required

Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.

minGram integer Required

Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.

termNotInBounds string

Value that indicates whether to index tokens shorter than minGram or longer than maxGram.

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is edgeGram.

Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.

Hide attribute Show attribute

type string Required

Human-readable label that identifies this token filter type.

Value is flattenGraph.

Filter that normalizes tokens using a standard Unicode Normalization Mode.

Hide attributes Show attributes

normalizationForm string

Normalization form to apply.

Values are nfd, nfc, nfkd, or nfkc. Default value is nfc.

type string Required

Human-readable label that identifies this token filter type.

Value is icuNormalizer.

Filter that removes tokens that are too short or too long.

Hide attributes Show attributes

max integer

Number that specifies the maximum length of a token. Value must be greater than or equal to min.

Default value is 255.

min integer

Number that specifies the minimum length of a token. This value must be less than or equal to max.

Default value is 0.

type string Required

Human-readable label that identifies this token filter type.

Value is length.

Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.

Hide attributes Show attributes

maxGram integer Required

Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to minGram.

minGram integer Required

Value that specifies the minimum length of generated n-grams. This value must be less than or equal to maxGram.

termNotInBounds string

Value that indicates whether to index tokens shorter than minGram or longer than maxGram.

Values are omit or include. Default value is omit.

type string Required

Human-readable label that identifies this token filter type.

Value is nGram.

Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.

Hide attribute Show attribute

type string Required

Human-readable label that identifies this token filter type.

Value is porterStemming.

Filter that applies a regular expression to each token, replacing matches with a specified string.

Hide attributes Show attributes

matches string Required

Value that indicates whether to replace only the first matching pattern or all matching patterns.

Values are all or first.

pattern string Required

Regular expression pattern to apply to each token.

replacement string Required

Replacement string to substitute wherever a matching pattern occurs.

type string Required

Human-readable label that identifies this token filter type.

Value is regex.

Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.

Hide attributes Show attributes

maxShingleSize integer Required

Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to minShingleSize.

minShingleSize integer Required

Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to maxShingleSize.

type string Required

Human-readable label that identifies this token filter type.

Value is shingle.

Filter that stems tokens using a Snowball-generated stemmer.

Hide attributes Show attributes

stemmerName string Required

Snowball-generated stemmer to use.

Values are arabic, armenian, basque, catalan, danish, dutch, english, finnish, french, german, german2, hungarian, irish, italian, kp, lithuanian, lovins, norwegian, porter, portuguese, romanian, russian, spanish, swedish, or turkish.

type string Required

Human-readable label that identifies this token filter type.

Value is snowballStemming.

Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.

Hide attributes Show attributes

ignoreCase boolean

Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove.

Default value is true.

tokens array[string] Required

The stop words that correspond to the tokens to remove. Value must be one or more stop words.

type string Required

Human-readable label that identifies this token filter type.

Value is stopword.

Filter that splits tokens into sub-tokens based on configured rules.

Hide attributes Show attributes

delimiterOptions object

Object that contains the rules that determine how to split words into sub-words.

Hide delimiterOptions attributes Show delimiterOptions attributes object

concatenateAll boolean

Flag that indicates whether to concatenate runs.

Default value is false.

concatenateNumbers boolean

Flag that indicates whether to concatenate runs of sub-numbers.

Default value is false.

concatenateWords boolean

Flag that indicates whether to concatenate runs of sub-words.

Default value is false.

generateNumberParts boolean

Flag that indicates whether to split tokens based on sub-numbers. For example, if true, this option splits 100-2 into 100 and 2.

Default value is true.

generateWordParts boolean

Flag that indicates whether to split tokens based on sub-words.

Default value is true.

ignoreKeywords boolean

Flag that indicates whether to skip tokens with the keyword attribute set to true.

Default value is false.

preserveOriginal boolean

Flag that indicates whether to generate tokens of the original words.

Default value is true.

splitOnCaseChange boolean

Flag that indicates whether to split tokens based on letter-case transitions.

Default value is true.

splitOnNumerics boolean

Flag that indicates whether to split tokens based on letter-number transitions.

Default value is true.

stemEnglishPossessive boolean

Flag that indicates whether to remove trailing possessives from each sub-word.

Default value is true.

protectedWords object

Object that contains options for protected words.

Hide protectedWords attributes Show protectedWords attributes object

ignoreCase boolean

Flag that indicates whether to ignore letter case sensitivity for protected words.

Default value is true.

words array[string] Required

List that contains the tokens to protect from delimination.

type string Required

Human-readable label that identifies this token filter type.

Value is wordDelimiterGraph.

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.

One of:
tokenizeredgeGram object tokenizerkeyword object tokenizernGram object tokenizerregexCaptureGroup object tokenizerregexSplit object tokenizerstandard object tokenizeruaxUrlEmail object tokenizerwhitespace object

Tokenizer that splits input from the left side, or "edge", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.

Hide attributes Show attributes

maxGram integer Required

Characters to include in the longest token that Atlas Search creates.

minGram integer Required

Characters to include in the shortest token that Atlas Search creates.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is edgeGram.

Tokenizer that splits input into text chunks, or "n-grams", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.

Hide attributes Show attributes

maxGram integer Required

Characters to include in the longest token that Atlas Search creates.

minGram integer Required

Characters to include in the shortest token that Atlas Search creates.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is edgeGram.

Tokenizer that uses a regular expression pattern to extract tokens.

Hide attributes Show attributes

group integer Required

Index of the character group within the matching expression to extract into tokens. Use 0 to extract all character groups.

pattern string Required

Regular expression to match against.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexCaptureGroup.

Tokenizer that splits tokens using a regular-expression based delimiter.

Hide attributes Show attributes

pattern string Required

Regular expression to match against.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is regexSplit.

Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.

Hide attributes Show attributes

maxTokenLength integer

Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is standard.

Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the standard tokenizer to create tokens based on word break rules.

Hide attributes Show attributes

maxTokenLength integer

Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is uaxUrlEmail.

Tokenizer that creates tokens based on occurrences of whitespace between words.

Hide attributes Show attributes

maxTokenLength integer

Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens.

Default value is 255.

type string Required Discriminator

Human-readable label that identifies this tokenizer type.

Value is whitespace.

mappings object

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.

Default value is false.

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

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.
Hide attributes Show attributes

collectionName string Required

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

database string Required

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

name string Required

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

numPartitions integer(int32)

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

Default value is 1.

type string Discriminator

Type of the index. Default type is search.

Value is vectorSearch.

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
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.
409 application/json

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

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes

atlas api createAtlasSearchIndexDeprecated --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.CreateAtlasSearchIndexDeprecatedApiParams{}
	sdkResp, httpResp, err := client.AtlasSearchApi.
		CreateAtlasSearchIndexDeprecatedWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
  -d '{ <Payload> }'

Request examples

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "charFilters": [
        {
          "ignoredTags": [
            "string"
          ],
          "type": "htmlStrip"
        }
      ],
      "name": "string",
      "tokenFilters": [
        {
          "originalTokens": "omit",
          "type": "asciiFolding"
        }
      ],
      "tokenizer": {
        "maxGram": 42,
        "minGram": 42,
        "type": "edgeGram"
      }
    }
  ],
  "mappings": {
    "dynamic": false,
    "fields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  },
  "searchAnalyzer": "lucene.standard",
  "storedSource": {
    "include | exclude": [
      "field1",
      "field2"
    ]
  },
  "synonyms": [
    {
      "analyzer": "lucene.standard",
      "name": "string",
      "source": {
        "collection": "string"
      }
    }
  ]
}

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "fields": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}

Response examples (200)

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "analyzer": "lucene.standard",
  "analyzers": [
    {
      "charFilters": [
        {
          "ignoredTags": [
            "string"
          ],
          "type": "htmlStrip"
        }
      ],
      "name": "string",
      "tokenFilters": [
        {
          "originalTokens": "omit",
          "type": "asciiFolding"
        }
      ],
      "tokenizer": {
        "maxGram": 42,
        "minGram": 42,
        "type": "edgeGram"
      }
    }
  ],
  "mappings": {
    "dynamic": false,
    "fields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  },
  "searchAnalyzer": "lucene.standard",
  "storedSource": {
    "include | exclude": [
      "field1",
      "field2"
    ]
  },
  "synonyms": [
    {
      "analyzer": "lucene.standard",
      "name": "string",
      "source": {
        "collection": "string"
      }
    }
  ]
}

{
  "collectionName": "string",
  "database": "string",
  "name": "string",
  "numPartitions": 1,
  "type": "search",
  "fields": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Create Search Nodes

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment

Service accounts Digest auth

Creates Search Nodes for the specified cluster.

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

Label that identifies the cluster to create Search Nodes for.

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

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

Body Required

Creates Search Nodes for the specified cluster.

specs array[object] Required

List of settings that configure the Search Nodes for your cluster.

NOTE: We accept a single configuration for all nodes currently.

At least 1 but not more than 1 element.
Hide specs attributes Show specs attributes object
- instanceSize string Required
  
  Hardware specification for the Search Node instance sizes.
  
  Values are S20_HIGHCPU_NVME, S30_HIGHCPU_NVME, S40_HIGHCPU_NVME, S50_HIGHCPU_NVME, S60_HIGHCPU_NVME, S70_HIGHCPU_NVME, S80_HIGHCPU_NVME, S30_LOWCPU_NVME, S40_LOWCPU_NVME, S50_LOWCPU_NVME, S60_LOWCPU_NVME, S70_LOWCPU_NVME, S80_LOWCPU_NVME, S90_LOWCPU_NVME, S100_LOWCPU_NVME, S110_LOWCPU_NVME, S120_LOWCPU_NVME, S130_LOWCPU_NVME, S135_LOWCPU_NVME, S140_LOWCPU_NVME, S40_STORAGE_NVME, S50_STORAGE_NVME, S60_STORAGE_NVME, S80_STORAGE_NVME, or S90_STORAGE_NVME.
- nodeCount integer(int32) Required
  
  Number of Search Nodes in the cluster.
  
  Minimum value is 2, maximum value is 32.

Responses

201 application/vnd.atlas.2024-05-30+json

Created
Hide response attributes Show response attributes object
- encryptionAtRestProvider string
  
  Cloud service provider that manages your customer keys to provide an additional layer of Encryption At Rest for the cluster.
  
  Values are NONE, AWS, AZURE, or GCP.
  
  Encryption at Rest using Customer Key Management
- groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- id string
  
  Unique 24-hexadecimal digit string that identifies the search deployment.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- specs array[object]
  
  List of settings that configure the Search Nodes for your cluster. The configuration will be returned for each region and shard.
  
  Hide specs attributes Show specs attributes object
  
  instanceSize string Required
  
  Hardware specification for the Search Node instance sizes.
  
  Values are S20_HIGHCPU_NVME, S30_HIGHCPU_NVME, S40_HIGHCPU_NVME, S50_HIGHCPU_NVME, S60_HIGHCPU_NVME, S70_HIGHCPU_NVME, S80_HIGHCPU_NVME, S30_LOWCPU_NVME, S40_LOWCPU_NVME, S50_LOWCPU_NVME, S60_LOWCPU_NVME, S70_LOWCPU_NVME, S80_LOWCPU_NVME, S90_LOWCPU_NVME, S100_LOWCPU_NVME, S110_LOWCPU_NVME, S120_LOWCPU_NVME, S130_LOWCPU_NVME, S135_LOWCPU_NVME, S140_LOWCPU_NVME, S40_STORAGE_NVME, S50_STORAGE_NVME, S60_STORAGE_NVME, S80_STORAGE_NVME, or S90_STORAGE_NVME.
  
  nodeCount integer(int32) Required
  
  Number of Search Nodes in the cluster.
  
  Minimum value is 2, maximum value is 32.
- stateName string
  
  Human-readable label that indicates the current operating condition of this search deployment.
  
  Values are IDLE, PAUSED, or UPDATING.
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.
409 application/json

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

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment

atlas api createAtlasSearchDeployment --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.CreateAtlasSearchDeploymentApiParams{}
	sdkResp, httpResp, err := client.AtlasSearchApi.
		CreateAtlasSearchDeploymentWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \
  -d '{ <Payload> }'

Request examples

{
  "specs": [
    {
      "instanceSize": "S20_HIGHCPU_NVME",
      "nodeCount": 2
    }
  ]
}

Response examples (201)

{
  "encryptionAtRestProvider": "NONE",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "specs": [
    {
      "instanceSize": "S20_HIGHCPU_NVME",
      "nodeCount": 2
    }
  ],
  "stateName": "IDLE"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove One Atlas Search Index by Name

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}

Service accounts Digest auth

Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. This deletion is eventually consistent.

Atlas Search Indexes

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-]*$.
collectionName string Required

Name of the collection that contains one or more Atlas Search indexes.
databaseName string Required

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

Name of the Atlas Search index to delete.

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.2024-05-30+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.

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}

atlas api deleteAtlasSearchIndexByName --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeleteAtlasSearchIndexByNameApiParams{}
	httpResp, err := client.AtlasSearchApi.
		DeleteAtlasSearchIndexByNameWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}"

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Create One Snapshot Export Bucket

POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets

Service accounts Digest auth

Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}

Path parameters

groupId string Required

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

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

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

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
pretty boolean

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

Default value is false.

Prettyprint

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

Body object Required

Specifies the role and AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket that the Export Bucket should reference.

Disk backup snapshot Export Bucket Request.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots are exported to.

Value is AWS.
bucketName string Required

Human-readable label that identifies the AWS S3 Bucket that the role is authorized to export to.

Minimum length is 3, maximum length is 63.
iamRoleId string Required

Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.

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

Unified AWS Access role ID

Disk backup snapshot Export Bucket Request.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots are exported to.

Value is AZURE.
bucketName string

The name of the Azure Storage Container to export to. This can be omitted and computed from the serviceUrl if the serviceUrl includes a Azure Storage Container name. For example a serviceUrl of "https://examplestorageaccount.blob.core.windows.net/exportcontainer" will yield a computed bucketName of "exportcontainer". If the serviceUrl does not include a Container name, this field is required.

Minimum length is 3, maximum length is 63.
roleId string Required

Unique 24-hexadecimal digit string that identifies the Azure Cloud Provider Access Role that MongoDB Cloud uses to access the Azure Blob Storage Container.

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

URL of the Azure Storage Account to export to. For example: "https://examplestorageaccount.blob.core.windows.net/exportcontainer". Only standard endpoints (with "blob.core.windows.net") are supported.

Minimum length is 33, maximum length is 2048.
tenantId string(uuid) Deprecated

UUID that identifies the Azure Active Directory Tenant ID. Deprecated: this field is ignored; the tenantId of the Cloud Provider Access role (from roleId) is used.

Disk backup snapshot Export Bucket Request.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots are exported to.

Value is GCP.
bucketName string Required

Human-readable label that identifies the Google Cloud Storage Bucket that the role is authorized to export to.

Minimum length is 3, maximum length is 63.
roleId string Required

Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.

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

Responses

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

OK
One of:
DiskBackupSnapshotAWSExportBucketResponse object DiskBackupSnapshotAzureExportBucketResponse object DiskBackupSnapshotGCPExportBucketResponse object
Disk backup snapshot Export Bucket.

Hide attributes Show attributes

_id string Required

Unique 24-hexadecimal character string that identifies the Export Bucket.

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

bucketName string Required

The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.

Minimum length is 3, maximum length is 63.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots will be exported to.

Value is AWS.

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.

iamRoleId string Required

Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.

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

Unified AWS Access role ID
Disk backup snapshot Export Bucket.

Hide attributes Show attributes

_id string Required

Unique 24-hexadecimal character string that identifies the Export Bucket.

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

bucketName string Required

The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.

Minimum length is 3, maximum length is 63.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots will be exported to.

Value is AZURE.

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.

roleId string Required

Unique 24-hexadecimal digit string that identifies the Azure Cloud Provider Access Role that MongoDB Cloud uses to access the Azure Blob Storage Container.

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

serviceUrl string Required

URL of the Azure Storage Account to export to. Only standard endpoints (with "blob.core.windows.net") are supported.

Minimum length is 33, maximum length is 2048.

tenantId string(uuid) Required

UUID that identifies the Azure Active Directory Tenant ID used during exports.
Disk backup snapshot Export Bucket.

Hide attributes Show attributes

_id string Required

Unique 24-hexadecimal character string that identifies the Export Bucket.

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

bucketName string Required

The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to.

Minimum length is 3, maximum length is 63.

cloudProvider string Required Discriminator

Human-readable label that identifies the cloud provider that Snapshots will be exported to.

Value is GCP.

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.

roleId string Required

Unique 24-hexadecimal digit string that identifies the GCP Cloud Provider Access Role that MongoDB Cloud uses to access the Google Cloud Storage Bucket.

Format should match the following pattern: ^([a-f0-9]{24})$.
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.

POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets

atlas api createExportBucket --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.CreateExportBucketApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		CreateExportBucketWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \
  -d '{ <Payload> }'

Request examples

AWS

{
  "iamRoleId": "668c5f0ed436263134491592",
  "bucketName": "export-bucket",
  "cloudProvider": "AWS"
}

Azure

{
  "roleId": "668c5f0ed436263134491592",
  "bucketName": "examplecontainer",
  "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer",
  "cloudProvider": "AZURE"
}

GCP

{
  "roleId": "668c5f0ed436263134491592",
  "bucketName": "export-bucket",
  "cloudProvider": "GCP"
}

Response examples (200)

AWS

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas"
    }
  ],
  "iamRoleId": "668c5f0ed436263134491592",
  "bucketName": "export-bucket",
  "cloudProvider": "AWS"
}

Azure

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas"
    }
  ],
  "roleId": "668c5f0ed436263134491592",
  "tenantId": "4297fc77-1592-4de8-a6d5-a8c32401df87",
  "bucketName": "examplecontainer",
  "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer",
  "cloudProvider": "AZURE"
}

GCP

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas"
    }
  ],
  "roleId": "668c5f0ed436263134491592",
  "bucketName": "export-bucket",
  "cloudProvider": "GCP"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove All Cloud Backup Schedules

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule

Service accounts Digest auth

Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. Deprecated versions: v2-{2023-01-01}

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.

Responses

200 application/vnd.atlas.2024-08-05+json

OK
Hide response attributes Show response attributes object
- autoExportEnabled boolean
  
  Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket.
- clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster with the Snapshot you want to return.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- copySettings array[object]
  
  List that contains a document for each copy setting item in the desired backup policy.
  
  Copy setting item in the desired backup policy.
  
  Hide copySettings attributes Show copySettings attributes object
  
  cloudProvider string
  
  Human-readable label that identifies the cloud provider that stores the snapshot copy.
  
  Values are AWS, AZURE, or GCP.
  
  frequencies array[string]
  
  List that describes which types of snapshots to copy.
  
  Values are HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY, or ON_DEMAND.
  
  regionName string
  
  Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region'.
  
  Cloud Provider Regions
  
  shouldCopyOplogs boolean
  
  Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
  
  zoneId string Required
  
  Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Return One Cluster From One Project
- export object
  
  Policy for automatically exporting Cloud Backup Snapshots.
  
  Hide export attributes Show export attributes object
  
  exportBucketId string
  
  Unique 24-hexadecimal character string that identifies the Export Bucket.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  frequencyType string
  
  Human-readable label that indicates the rate at which the export policy item occurs.
  
  Values are monthly or yearly.
- extraRetentionSettings array[object]
  
  List that contains a document for each extra retention setting item in the desired backup policy.
  
  extra retention setting item in the desired backup policy.
  
  Hide extraRetentionSettings attributes Show extraRetentionSettings attributes object
  
  frequencyType string
  
  The frequency type for the extra retention settings for the cluster.
  
  Values are HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY, or ON_DEMAND.
  
  retentionDays integer(int32)
  
  The number of extra retention days for the cluster.
- 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.
- nextSnapshot string(date-time)
  
  Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- policies array[object]
  
  Rules set for this backup schedule.
  
  List that contains a document for each backup policy item in the desired backup policy.
  
  Not more than 1 element.
  
  Hide policies attributes Show policies attributes object
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this backup policy.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  policyItems array[object]
  
  List that contains the specifications for one policy.
  
  Specifications for one policy.
  
  Hide policyItems attributes Show policyItems attributes object
  
  frequencyInterval integer(int32) Required
  
  Number that indicates the frequency interval for a set of Snapshots. A value of 1 specifies the first instance of the corresponding frequencyType.
  
  In a yearly policy item, 1 indicates that the yearly Snapshot occurs on the first day of January and 12 indicates the first day of December.
  
  In a monthly policy item, 1 indicates that the monthly Snapshot occurs on the first day of the month and 40 indicates the last day of the month.
  
  In a weekly policy item, 1 indicates that the weekly Snapshot occurs on Monday and 7 indicates Sunday.
  
  In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only 12 as the frequency interval value.
  
  MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.
  
  Values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, or 40.
  
  frequencyType string Required
  
  Human-readable label that identifies the frequency type associated with the backup policy.
  
  Values are daily, hourly, weekly, monthly, yearly, or ondemand.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies this backup policy item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  retentionUnit string Required
  
  Unit of time in which MongoDB Cloud measures Snapshot retention.
  
  Values are days, weeks, months, or years.
  
  retentionValue integer(int32) Required
  
  Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.
  
  For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.
- referenceHourOfDay integer(int32)
  
  Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot.
- referenceMinuteOfHour integer(int32)
  
  Minute of the referenceHourOfDay that represents when MongoDB Cloud takes the Snapshot.
- restoreWindowDays integer(int32)
  
  Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only.
- useOrgAndGroupNamesInExportPrefix boolean
  
  Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket.
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.

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule

atlas api deleteAllBackupSchedules --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeleteAllBackupSchedulesApiParams{}
	httpResp, err := client.CloudBackupsApi.
		DeleteAllBackupSchedulesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"

Response examples (200)

{
  "autoExportEnabled": true,
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "copySettings": [
    {
      "cloudProvider": "AWS",
      "frequencies": [
        "HOURLY"
      ],
      "regionName": "string",
      "shouldCopyOplogs": true,
      "zoneId": "32b6e34b3d91647abb20e7b8"
    }
  ],
  "export": {
    "exportBucketId": "32b6e34b3d91647abb20e7b8",
    "frequencyType": "monthly"
  },
  "extraRetentionSettings": [
    {
      "frequencyType": "HOURLY",
      "retentionDays": 42
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "nextSnapshot": "2025-05-04T09:42:00Z",
  "policies": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "policyItems": [
        {
          "frequencyInterval": 1,
          "frequencyType": "daily",
          "id": "32b6e34b3d91647abb20e7b8",
          "retentionUnit": "days",
          "retentionValue": 42
        }
      ]
    }
  ],
  "referenceHourOfDay": 42,
  "referenceMinuteOfHour": 42,
  "restoreWindowDays": 42,
  "useOrgAndGroupNamesInExportPrefix": true
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Take One On-Demand Snapshot

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots

Service accounts Digest auth

Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.

To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role.

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

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

Body Required

Takes one on-demand snapshot.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status" : "onDemand".
retentionInDays integer(int32)

Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1.

Minimum value is 1.

Responses

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

OK
One of:
DiskBackupReplicaSet object DiskBackupShardedClusterSnapshot object
Details of the replica set snapshot that MongoDB Cloud created.

Hide attributes Show attributes

createdAt string(date-time)

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

expiresAt string(date-time)

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

frequencyType string

Human-readable label that identifies how often this snapshot triggers.

Values are hourly, daily, weekly, monthly, or yearly.

id string

Unique 24-hexadecimal digit string that identifies the snapshot.

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

masterKeyUUID string(uuid)

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

mongodVersion string

Version of the MongoDB host that this snapshot backs up.

Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).

policyItems array[string]

List that contains unique identifiers for the policy items.

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

snapshotType string

Human-readable label that identifies when this snapshot triggers.

Values are onDemand, scheduled, or fallback.

status string

Human-readable label that indicates the stage of the backup process for this snapshot.

Values are queued, inProgress, completed, or failed.

storageSizeBytes integer(int64)

Number of bytes taken to store the backup at time of snapshot.

type string Discriminator

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

Value is replicaSet.

cloudProvider string

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

Values are AWS, AZURE, or GCP.

copyRegions array[string]

List that identifies the regions to which MongoDB Cloud copies the snapshot.

replicaSetName string

Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when "type": "replicaSet".
Details of the sharded cluster snapshot that MongoDB Cloud created.

Hide attributes Show attributes

createdAt string(date-time)

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

expiresAt string(date-time)

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

frequencyType string

Human-readable label that identifies how often this snapshot triggers.

Values are hourly, daily, weekly, monthly, or yearly.

id string

Unique 24-hexadecimal digit string that identifies the snapshot.

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

masterKeyUUID string(uuid)

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

mongodVersion string

Version of the MongoDB host that this snapshot backs up.

Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).

policyItems array[string]

List that contains unique identifiers for the policy items.

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

snapshotType string

Human-readable label that identifies when this snapshot triggers.

Values are onDemand, scheduled, or fallback.

status string

Human-readable label that indicates the stage of the backup process for this snapshot.

Values are queued, inProgress, completed, or failed.

storageSizeBytes integer(int64)

Number of bytes taken to store the backup at time of snapshot.

type string Discriminator

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

Value is shardedCluster.

configServerType string

Describes a sharded cluster's config server type.

Values are EMBEDDED or DEDICATED.

members array[object]

List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when "type" : "SHARDED_CLUSTER".

Hide members attributes Show members attributes object

cloudProvider string Required

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

Values are AWS, AZURE, or GCP.

id string Required

Unique 24-hexadecimal digit string that identifies the snapshot.

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

replicaSetName string Required

Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.

snapshotIds array[string]

List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when "type": "SHARDED_CLUSTER". These identifiers should match the ones specified in the members[n].id parameters. This allows you to map a snapshot to its shard or config host name.

Format of each should match the following pattern: ^([a-f0-9]{24})$.
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.

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots

atlas api takeSnapshot --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.TakeSnapshotApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		TakeSnapshotWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
  -d '{ <Payload> }'

Request examples

{
  "description": "string",
  "retentionInDays": 42
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "expiresAt": "2025-05-04T09:42:00Z",
  "frequencyType": "hourly",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "masterKeyUUID": "string",
  "mongodVersion": "string",
  "policyItems": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotType": "onDemand",
  "status": "queued",
  "storageSizeBytes": 42,
  "type": "replicaSet",
  "cloudProvider": "AWS",
  "copyRegions": [
    "string"
  ],
  "replicaSetName": "string"
}

{
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "expiresAt": "2025-05-04T09:42:00Z",
  "frequencyType": "hourly",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "masterKeyUUID": "string",
  "mongodVersion": "string",
  "policyItems": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotType": "onDemand",
  "status": "queued",
  "storageSizeBytes": 42,
  "type": "replicaSet",
  "configServerType": "EMBEDDED",
  "members": [
    {
      "cloudProvider": "AWS",
      "id": "32b6e34b3d91647abb20e7b8",
      "replicaSetName": "string"
    }
  ],
  "snapshotIds": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Sharded Cluster Cloud Backups

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters

Service accounts Digest auth

Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role.

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

Responses

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

OK
Hide response attributes Show response attributes object
- 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.
- results array[object]
  
  List of returned documents that MongoDB Cloud provides when completing this request.
  
  Details of the sharded cluster snapshot that MongoDB Cloud created.
  
  Hide results attributes Show results attributes object
  
  configServerType string
  
  Describes a sharded cluster's config server type.
  
  Values are EMBEDDED or DEDICATED.
  
  createdAt string(date-time)
  
  Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  description string
  
  Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".
  
  expiresAt string(date-time)
  
  Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  frequencyType string
  
  Human-readable label that identifies how often this snapshot triggers.
  
  Values are hourly, daily, weekly, monthly, or yearly.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies the snapshot.
  
  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 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.
  
  masterKeyUUID string(uuid)
  
  Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.
  
  members array[object]
  
  List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when "type" : "SHARDED_CLUSTER".
  
  Hide members attributes Show members attributes object
  
  cloudProvider string Required
  
  Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".
  
  Values are AWS, AZURE, or GCP.
  
  id string Required
  
  Unique 24-hexadecimal digit string that identifies the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  replicaSetName string Required
  
  Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.
  
  mongodVersion string
  
  Version of the MongoDB host that this snapshot backs up.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
  
  policyItems array[string]
  
  List that contains unique identifiers for the policy items.
  
  Format of each should match the following pattern: ^([a-f0-9]{24})$.
  
  snapshotIds array[string]
  
  List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when "type": "SHARDED_CLUSTER". These identifiers should match the ones specified in the members[n].id parameters. This allows you to map a snapshot to its shard or config host name.
  
  Format of each should match the following pattern: ^([a-f0-9]{24})$.
  
  snapshotType string
  
  Human-readable label that identifies when this snapshot triggers.
  
  Values are onDemand, scheduled, or fallback.
  
  status string
  
  Human-readable label that indicates the stage of the backup process for this snapshot.
  
  Values are queued, inProgress, completed, or failed.
  
  storageSizeBytes integer(int64)
  
  Number of bytes taken to store the backup at time of snapshot.
  
  type string
  
  Human-readable label that categorizes the cluster as a replica set or sharded cluster.
  
  Values are replicaSet or shardedCluster.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
  
  Minimum value is 0.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
401 application/json

Unauthorized.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
403 application/json

Forbidden.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
404 application/json

Not Found.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters

atlas api listShardedClusterBackups --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListShardedClusterBackupsApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		ListShardedClusterBackupsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "configServerType": "EMBEDDED",
      "createdAt": "2025-05-04T09:42:00Z",
      "description": "string",
      "expiresAt": "2025-05-04T09:42:00Z",
      "frequencyType": "hourly",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "masterKeyUUID": "string",
      "members": [
        {
          "cloudProvider": "AWS",
          "id": "32b6e34b3d91647abb20e7b8",
          "replicaSetName": "string"
        }
      ],
      "mongodVersion": "string",
      "policyItems": [
        "32b6e34b3d91647abb20e7b8"
      ],
      "snapshotIds": [
        "32b6e34b3d91647abb20e7b8"
      ],
      "snapshotType": "onDemand",
      "status": "queued",
      "storageSizeBytes": 42,
      "type": "replicaSet"
    }
  ],
  "totalCount": 42
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove One Link-Token

DELETE /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens

Service accounts Digest auth

Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource.

Path parameters

orgId string Required

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

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.

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.

DELETE /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens

atlas api deleteLinkToken --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeleteLinkTokenApiParams{}
	httpResp, err := client.CloudMigrationServiceApi.
		DeleteLinkTokenWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens"

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Cloud Provider Access Roles

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

Service accounts Digest auth

Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

Path parameters

groupId string Required

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

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

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

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
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
Hide response attributes Show response attributes object
- awsIamRoles array[object]
  
  List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.
  
  Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide awsIamRoles attributes Show awsIamRoles attributes object
  
  Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  providerName string Required
  
  Human-readable label that identifies the cloud provider of the role.
  
  Values are AWS, AZURE, or GCP.
  
  atlasAWSAccountArn string
  
  Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.
  
  Minimum length is 20, maximum length is 2048.
  
  atlasAssumedRoleExternalId string(uuid)
  
  Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.
  
  authorizedDate string(date-time)
  
  Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  createdDate string(date-time)
  
  Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  featureUsages array[object]
  
  List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  One of:
  CloudProviderAccessDataLakeFeatureUsage object CloudProviderAccessEncryptionAtRestFeatureUsage object CloudProviderAccessExportSnapshotFeatureUsage object CloudProviderAccessPushBasedLogExportFeatureUsage object
  
  Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is ATLAS_DATA_LAKE.
  
  featureId object
  
  Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  name string
  
  Human-readable label that identifies the data lake.
  
  Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is ENCRYPTION_AT_REST.
  
  featureId object | null
  
  Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.
  
  Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is EXPORT_SNAPSHOT.
  
  featureId object
  
  Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  exportBucketId string
  
  Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is PUSH_BASED_LOG_EXPORT.
  
  featureId object
  
  Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  bucketName string
  
  Name of the AWS S3 bucket to which your logs will be exported to.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  iamAssumedRoleArn string
  
  Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
  
  Minimum length is 20, maximum length is 2048.
  
  roleId string
  
  Unique 24-hexadecimal digit string that identifies the role.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- azureServicePrincipals array[object]
  
  List that contains the Azure Service Principals registered with MongoDB Cloud.
  
  Details that describe the features linked to the Azure Service Principal.
  
  Hide azureServicePrincipals attributes Show azureServicePrincipals attributes object
  
  Details that describe the features linked to the Azure Service Principal.
  
  providerName string Required
  
  Human-readable label that identifies the cloud provider of the role.
  
  Values are AWS, AZURE, or GCP.
  
  _id string
  
  Unique 24-hexadecimal digit string that identifies the role.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  atlasAzureAppId string(uuid)
  
  Azure Active Directory Application ID of Atlas.
  
  createdDate string(date-time)
  
  Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  featureUsages array[object]
  
  List that contains application features associated with this Azure Service Principal.
  
  One of:
  CloudProviderAccessDataLakeFeatureUsage object CloudProviderAccessEncryptionAtRestFeatureUsage object CloudProviderAccessExportSnapshotFeatureUsage object CloudProviderAccessPushBasedLogExportFeatureUsage object
  
  Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is ATLAS_DATA_LAKE.
  
  featureId object
  
  Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  name string
  
  Human-readable label that identifies the data lake.
  
  Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is ENCRYPTION_AT_REST.
  
  featureId object | null
  
  Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.
  
  Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is EXPORT_SNAPSHOT.
  
  featureId object
  
  Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  exportBucketId string
  
  Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role.
  
  Hide attributes Show attributes
  
  featureType string Discriminator
  
  Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.
  
  Value is PUSH_BASED_LOG_EXPORT.
  
  featureId object
  
  Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.
  
  Hide featureId attributes Show featureId attributes object
  
  bucketName string
  
  Name of the AWS S3 bucket to which your logs will be exported to.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies your project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  lastUpdatedDate string(date-time)
  
  Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  servicePrincipalId string(uuid)
  
  UUID string that identifies the Azure Service Principal.
  
  tenantId string(uuid)
  
  UUID String that identifies the Azure Active Directory Tenant ID.
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.

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

atlas api listCloudProviderAccessRoles --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListCloudProviderAccessRolesApiParams{}
	sdkResp, httpResp, err := client.CloudProviderAccessApi.
		ListCloudProviderAccessRolesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"

Response examples (200)

{
  "awsIamRoles": [
    {
      "providerName": "AWS",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2025-05-04T09:42:00Z",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8"
    }
  ],
  "azureServicePrincipals": [
    {
      "providerName": "AWS",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "lastUpdatedDate": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string"
    }
  ]
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Deauthorize One Cloud Provider Access Role

DELETE /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}

Service accounts Digest auth

Revokes access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

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

Human-readable label that identifies the cloud provider of the role to deauthorize.

Values are AWS, AZURE, or GCP.
roleId string Required

Unique 24-hexadecimal digit string that identifies the role.

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

No Content
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.

DELETE /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}

atlas api deauthorizeCloudProviderAccessRole --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeauthorizeCloudProviderAccessRoleApiParams{}
	httpResp, err := client.CloudProviderAccessApi.
		DeauthorizeCloudProviderAccessRoleWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}"

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove One Cluster from One Project

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}

Service accounts Digest auth

Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature is not available for serverless clusters.

This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 2026. Please use the deleteFlexCluster endpoint for Flex clusters instead. Deprecated versions: v2-{2023-01-01}

deleteFlexCluster

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
retainBackups boolean

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.

Responses

202 application/vnd.atlas.2023-02-01+json

Accepted
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.
409 application/json

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

DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}

atlas api deleteCluster --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeleteClusterApiParams{}
	httpResp, err := client.ClustersApi.
		DeleteClusterWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}"

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Load Sample Dataset into One Cluster

POST /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}

Service accounts Digest auth

Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

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

Human-readable label that identifies the cluster into which you load the sample dataset.

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.

Responses

201 application/vnd.atlas.2023-01-01+json

Created
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal character string that identifies this sample dataset.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster into which you loaded the sample dataset.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- completeDate string(date-time)
  
  Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
- createDate string(date-time)
  
  Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
- errorMessage string
  
  Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.
- state string
  
  Status of the sample dataset load job.
  
  Values are WORKING, FAILED, or COMPLETED.
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.
409 application/json

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

POST /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}

atlas api loadSampleDataset --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.LoadSampleDatasetApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		LoadSampleDatasetWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \
  -d '{ <Payload> }'

Response examples (201)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "completeDate": "2025-05-04T09:42:00Z",
  "createDate": "2025-05-04T09:42:00Z",
  "errorMessage": "string",
  "state": "WORKING"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return Status of Sample Dataset Load for One Cluster

GET /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}

Service accounts Digest auth

Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

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

Unique 24-hexadecimal digit string that identifies the loaded sample dataset.

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.

Responses

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

OK
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal character string that identifies this sample dataset.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster into which you loaded the sample dataset.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- completeDate string(date-time)
  
  Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
- createDate string(date-time)
  
  Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
- errorMessage string
  
  Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.
- state string
  
  Status of the sample dataset load job.
  
  Values are WORKING, FAILED, or COMPLETED.
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.

GET /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}

atlas api getSampleDatasetLoadStatus --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.GetSampleDatasetLoadStatusApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		GetSampleDatasetLoadStatusWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true"

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "completeDate": "2025-05-04T09:42:00Z",
  "createDate": "2025-05-04T09:42:00Z",
  "errorMessage": "string",
  "state": "WORKING"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return Cluster-Level Query Latency

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements

Service accounts Digest auth

Get a list of the Coll Stats Latency cluster-level measurements for the given namespace.

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 to retrieve metrics for.

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

Human-readable label that identifies the cluster topology to retrieve metrics for.

Values are PRIMARY, SECONDARY, or INDIVIDUAL_PROCESS.
databaseName string Required

Human-readable label that identifies the database.
collectionName string Required

Human-readable label that identifies the collection.

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.
metrics array[string]

List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.

Values are READS_OPS, READS_LATENCY, AVERAGE_READS_LATENCY, READS_P50_VALUE, READS_P95_VALUE, READS_P99_VALUE, WRITES_OPS, WRITES_LATENCY, AVERAGE_WRITES_LATENCY, WRITES_P50_VALUE, WRITES_P95_VALUE, WRITES_P99_VALUE, COMMANDS_OPS, COMMANDS_LATENCY, AVERAGE_COMMANDS_LATENCY, COMMANDS_P50_VALUE, COMMANDS_P95_VALUE, COMMANDS_P99_VALUE, TOTAL_OPS, TOTAL_LATENCY, AVERAGE_TOTAL_OPS_LATENCY, TOTAL_OPS_P50_VALUE, TOTAL_OPS_P95_VALUE, or TOTAL_OPS_P99_VALUE.
start string(date-time)

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
end string(date-time)

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.
period string

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.

Responses

200 application/vnd.atlas.2023-11-15+json

Succeeded
Hide response attributes Show response attributes object
- clusterId string
  
  Unique identifier for Clusters.
- clusterView string
  
  Cluster topology view.
- collectionName string
  
  Human-readable label that identifies the collection.
- databaseName string
  
  Human-readable label that identifies the database that the specified MongoDB process serves.
- end string(date-time)
  
  Date and time that specifies when to stop retrieving measurements. If you set end, you must set start. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- granularity string
  
  Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either period or start and end.
  
  Values are PT1M, PT5M, PT1H, or P1D.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the mongod or mongos.
  
  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 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.
- measurements array[object]
  
  List that contains measurements and their data points.
  
  Hide measurements attributes Show measurements attributes object
  
  dataPoints array[object]
  
  List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the value parameter returns null.
  
  Hide dataPoints attributes Show dataPoints attributes object
  
  timestamp string(date-time)
  
  Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  value number
  
  Value that comprises this data point.
  
  name string
  
  Human-readable label of the measurement that this data point covers.
  
  units string
  
  Element used to quantify the measurement. The resource returns units of throughput, storage, and time.
  
  Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES_PER_SECOND, MICROSECONDS, MILLISECONDS, PERCENT, SCALAR, or SCALAR_PER_SECOND.
- processId string
  
  Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.
  
  Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
- start string(date-time)
  
  Date and time that specifies when to start retrieving measurements. If you set start, you must set end. You can't set this parameter and period in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
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.

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements

atlas api getCollStatsLatencyNamespaceClusterMeasurements --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.GetCollStatsLatencyNamespaceClusterMeasurementsApiParams{}
	sdkResp, httpResp, err := client.CollectionLevelMetricsApi.
		GetCollStatsLatencyNamespaceClusterMeasurementsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true"

Response examples (200)

{
  "clusterId": "string",
  "clusterView": "string",
  "collectionName": "string",
  "databaseName": "string",
  "end": "2025-05-04T09:42:00Z",
  "granularity": "PT1M",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "measurements": [
    {
      "dataPoints": [
        {
          "timestamp": "2025-05-04T09:42:00Z",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "BYTES"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "start": "2025-05-04T09:42:00Z"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Federated Database Instances in One Project

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

Service accounts Digest auth

Returns the details of all federated database instances in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or higher role.

Path parameters

groupId string Required

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

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

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

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
pretty boolean

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

Default value is false.

Prettyprint
type string

Type of Federated Database Instances to return.

Values are USER or ONLINE_ARCHIVE. Default value is USER.

Responses

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

OK
Hide response attributes Show response attributes object
- cloudProviderConfig object
  
  Cloud provider where this Federated Database Instance is hosted.
  
  Hide cloudProviderConfig attributes Show cloudProviderConfig attributes object
  
  aws object
  
  Configuration for running Data Federation in AWS.
  
  Hide aws attributes Show aws attributes object
  
  externalId string
  
  Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.
  
  iamAssumedRoleARN string
  
  Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.
  
  Minimum length is 20, maximum length is 2048.
  
  iamUserARN string
  
  Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.
  
  roleId string Required
  
  Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  azure object
  
  Configuration for running Data Federation in Azure.
  
  Hide azure attributes Show azure attributes object
  
  atlasAppId string
  
  The App ID generated by Atlas for the Service Principal's access policy.
  
  roleId string Required
  
  Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  servicePrincipalId string
  
  The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.
  
  tenantId string
  
  The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.
  
  gcp object
  
  Configuration for running Data Federation in GCP.
  
  Hide gcp attributes Show gcp attributes object
  
  gcpServiceAccount string
  
  The email address of the Google Cloud Platform (GCP) service account created by Atlas which should be authorized to allow Atlas to access Google Cloud Storage.
  
  roleId string Required
  
  Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- dataProcessRegion object
  
  Information about the cloud provider region to which the Federated Database Instance routes client connections.
  
  Hide dataProcessRegion attributes Show dataProcessRegion attributes object
  
  cloudProvider string Required
  
  Name of the cloud service that hosts the Federated Database Instance's infrastructure.
  
  Values are AWS, AZURE, or GCP.
  
  region string Required
  
  Name of the region to which the data lake routes client connections.
  
  One of:
  ApiAtlasDataLakeAWSRegionView string AtlasDataFederationAzureRegion string AtlasDataFederationGCPRegion string
  
  Atlas Data Federation AWS Regions.
  
  Values are SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN, or SINGAPORE_SGP.
- groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- hostnames array[string]
  
  List that contains the hostnames assigned to the Federated Database Instance.
- name string
  
  Human-readable label that identifies the Federated Database Instance.
- privateEndpointHostnames array[object]
  
  List that contains the sets of private endpoints and hostnames.
  
  Set of Private endpoint and hostnames.
  
  Hide privateEndpointHostnames attributes Show privateEndpointHostnames attributes object
  
  hostname string
  
  Human-readable label that identifies the hostname.
  
  privateEndpoint string
  
  Human-readable label that identifies private endpoint.
- state string
  
  Label that indicates the status of the Federated Database Instance.
  
  Values are UNVERIFIED, ACTIVE, or DELETED.
- storage object
  
  Configuration information for each data store and its mapping to MongoDB Cloud databases.
  
  Hide storage attributes Show storage attributes object
  
  databases array[object]
  
  Array that contains the queryable databases and collections for this data lake.
  
  Database associated with this data lake. Databases contain collections and views.
  
  Hide databases attributes Show databases attributes object
  
  collections array[object]
  
  Array of collections and data sources that map to a stores data store.
  
  A collection and data sources that map to a stores data store.
  
  Hide collections attributes Show collections attributes object
  
  dataSources array[object]
  
  Array that contains the data stores that map to a collection for this data lake.
  
  Data store that maps to a collection for this data lake.
  
  Hide dataSources attributes Show dataSources attributes object
  
  allowInsecure boolean
  
  Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
  
  Default value is false.
  
  collection string
  
  Human-readable label that identifies the collection in the database. For creating a wildcard (*) collection, you must omit this parameter.
  
  collectionRegex string
  
  Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.
  
  database string
  
  Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.
  
  databaseRegex string
  
  Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see Go programming language.
  
  datasetName string
  
  Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.
  
  datasetPrefix string
  
  Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives.
  
  defaultFormat string
  
  File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.
  
  Values are .avro, .avro.bz2, .avro.gz, .bson, .bson.bz2, .bson.gz, .bsonx, .csv, .csv.bz2, .csv.gz, .json, .json.bz2, .json.gz, .orc, .parquet, .tsv, .tsv.bz2, or .tsv.gz.
  
  path string
  
  File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.Specify / to capture all files and folders from the prefix path.
  
  provenanceFieldName string
  
  Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider.
  
  storeName string
  
  Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
  
  trimLevel integer(int32)
  
  Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name.
  
  urls array[string]
  
  URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter.
  
  name string
  
  Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores.
  
  maxWildcardCollections integer(int32)
  
  Maximum number of wildcard collections in the database. This only applies to S3 data sources.
  
  Minimum value is 1, maximum value is 1000. Default value is 100.
  
  name string
  
  Human-readable label that identifies the database to which the data lake maps data.
  
  views array[object]
  
  Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.
  
  An aggregation pipeline that applies to the collection.
  
  Hide views attributes Show views attributes object
  
  name string
  
  Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection.
  
  pipeline string
  
  Aggregation pipeline stages to apply to the source collection.
  
  Aggregation Pipelines
  
  source string
  
  Human-readable label that identifies the source collection for the view.
  
  stores array[object]
  
  Array that contains the data stores for the data lake.
  
  One of:
  DataLakeS3StoreSettings object DataLakeDLSAWSStore object DataLakeDLSAzureStore object DataLakeDLSGCPStore object DataLakeAtlasStoreInstance object DataLakeHTTPStore object DataLakeAzureBlobStore object DataLakeGoogleCloudStorageStore object
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  additionalStorageClasses array[string]
  
  Collection of AWS S3 storage classes. Atlas Data Lake includes the files in these storage classes in the query results.
  
  Values are STANDARD, INTELLIGENT_TIERING, or STANDARD_IA.
  
  bucket string
  
  Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials.
  
  delimiter string
  
  The delimiter that separates databases.[n].collections.[n].dataSources.[n].path segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore () or a plus sign (+) or multiple characters, such as double underscores (_) as the delimiter. If omitted, defaults to /.
  
  includeTags boolean
  
  Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to true, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document.
  
  Default value is false.
  
  prefix string
  
  Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the databases.[n].collections.[n].dataSources.[n].path to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket.
  
  public boolean
  
  Flag that indicates whether the bucket is public. If set to true, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to false, the configured AWS IAM role must include permissions to access the S3 bucket.
  
  Default value is false.
  
  region string
  
  Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
  
  Values are US_GOV_WEST_1, US_GOV_EAST_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, AP_EAST_1, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_SOUTH_1, AP_SOUTH_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, ME_SOUTH_1, ME_CENTRAL_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, or GLOBAL.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  region string
  
  Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
  
  Values are US_GOV_WEST_1, US_GOV_EAST_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, CA_CENTRAL_1, EU_NORTH_1, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, EU_CENTRAL_2, AP_EAST_1, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_NORTHEAST_3, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_SOUTHEAST_3, AP_SOUTHEAST_4, AP_SOUTH_1, AP_SOUTH_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, ME_SOUTH_1, ME_CENTRAL_1, AF_SOUTH_1, EU_SOUTH_1, EU_SOUTH_2, IL_CENTRAL_1, CA_WEST_1, or GLOBAL.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  region string
  
  Microsoft Azure Regions.
  
  Values are US_CENTRAL, US_EAST, US_EAST_2, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, GERMANY_CENTRAL, GERMANY_NORTH_EAST, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWEDEN_CENTRAL, SWEDEN_SOUTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, UK_SOUTH, UK_WEST, NORWAY_EAST, NORWAY_WEST, INDIA_CENTRAL, INDIA_SOUTH, INDIA_WEST, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, UAE_CENTRAL, UAE_NORTH, or QATAR_CENTRAL.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  region string
  
  Google Cloud Platform Regions.
  
  Values are ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  clusterName string
  
  Human-readable label of the MongoDB Cloud cluster on which the store is based.
  
  projectId string
  
  Unique 24-hexadecimal digit string that identifies the project.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  readConcern object
  
  MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.
  
  Hide readConcern attribute Show readConcern attribute object
  
  level string
  
  Read Concern level that specifies the consistency and availability of the data read.
  
  Values are LOCAL, MAJORITY, LINEARIZABLE, SNAPSHOT, or AVAILABLE.
  
  Read Concern Level
  
  readPreference object
  
  MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.
  
  Hide readPreference attributes Show readPreference attributes object
  
  maxStalenessSeconds integer(int32)
  
  Maximum replication lag, or staleness, for reads from secondaries.
  
  mode string
  
  Read preference mode that specifies to which replica set member to route the read requests.
  
  Values are primary, primaryPreferred, secondary, secondaryPreferred, or nearest.
  
  Read Preference Modes
  
  tagSets array[array]
  
  List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.
  
  Read Preference Tag Set Lists
  
  Hide tagSets attributes Show tagSets attributes object
  
  name string
  
  Human-readable label of the tag.
  
  value string
  
  Value of the tag.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  allowInsecure boolean
  
  Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
  
  Default value is false.
  
  defaultFormat string
  
  Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the databases.[n].collections.[n].dataSources object.
  
  urls array[string]
  
  Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  containerName string
  
  Human-readable label that identifies the name of the container.
  
  delimiter string
  
  Delimiter.
  
  prefix string
  
  Prefix.
  
  public boolean
  
  Flag that indicates whether the blob store is public. If set to true, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to false, the configured Azure service principal must include permissions to access the blob store.
  
  Default value is false.
  
  region string
  
  Microsoft Azure Regions.
  
  Values are US_CENTRAL, US_EAST, US_EAST_2, US_NORTH_CENTRAL, US_WEST, US_SOUTH_CENTRAL, EUROPE_NORTH, EUROPE_WEST, US_WEST_CENTRAL, US_WEST_2, US_WEST_3, CANADA_EAST, CANADA_CENTRAL, BRAZIL_SOUTH, BRAZIL_SOUTHEAST, AUSTRALIA_CENTRAL, AUSTRALIA_CENTRAL_2, AUSTRALIA_EAST, AUSTRALIA_SOUTH_EAST, GERMANY_CENTRAL, GERMANY_NORTH_EAST, GERMANY_WEST_CENTRAL, GERMANY_NORTH, SWEDEN_CENTRAL, SWEDEN_SOUTH, SWITZERLAND_NORTH, SWITZERLAND_WEST, UK_SOUTH, UK_WEST, NORWAY_EAST, NORWAY_WEST, INDIA_CENTRAL, INDIA_SOUTH, INDIA_WEST, CHINA_EAST, CHINA_NORTH, ASIA_EAST, JAPAN_EAST, JAPAN_WEST, ASIA_SOUTH_EAST, KOREA_CENTRAL, KOREA_SOUTH, FRANCE_CENTRAL, FRANCE_SOUTH, SOUTH_AFRICA_NORTH, SOUTH_AFRICA_WEST, UAE_CENTRAL, UAE_NORTH, or QATAR_CENTRAL.
  
  replacementDelimiter string
  
  Replacement Delimiter.
  
  serviceURL string
  
  Service URL.
  
  Group of settings that define where the data is stored.
  
  Hide attributes Show attributes
  
  name string
  
  Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an M10 or higher cluster.
  
  provider string Required Discriminator
  
  Value is object.
  
  bucket string
  
  Human-readable label that identifies the Google Cloud Storage bucket.
  
  delimiter string
  
  Delimiter.
  
  prefix string
  
  Prefix.
  
  public boolean
  
  Flag that indicates whether the bucket is public. If set to true, MongoDB Cloud doesn't use the configured GCP service account to access the bucket. If set to false, the configured GCP service acccount must include permissions to access the bucket.
  
  Default value is false.
  
  region string
  
  Google Cloud Platform Regions.
  
  Values are ASIA_EAST_2, ASIA_NORTHEAST_2, ASIA_NORTHEAST_3, ASIA_SOUTH_1, ASIA_SOUTH_2, ASIA_SOUTHEAST_2, AUSTRALIA_SOUTHEAST_1, AUSTRALIA_SOUTHEAST_2, CENTRAL_US, EASTERN_ASIA_PACIFIC, EASTERN_US, EUROPE_CENTRAL_2, EUROPE_NORTH_1, EUROPE_WEST_2, EUROPE_WEST_3, EUROPE_WEST_4, EUROPE_WEST_6, EUROPE_WEST_10, EUROPE_WEST_12, MIDDLE_EAST_CENTRAL_1, MIDDLE_EAST_CENTRAL_2, MIDDLE_EAST_WEST_1, NORTH_AMERICA_NORTHEAST_1, NORTH_AMERICA_NORTHEAST_2, NORTHEASTERN_ASIA_PACIFIC, SOUTH_AMERICA_EAST_1, SOUTH_AMERICA_WEST_1, SOUTHEASTERN_ASIA_PACIFIC, US_EAST_4, US_EAST_5, US_WEST_2, US_WEST_3, US_WEST_4, US_SOUTH_1, WESTERN_EUROPE, or WESTERN_US.
  
  replacementDelimiter string
  
  Replacement Delimiter.
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.

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

atlas api listFederatedDatabases --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListFederatedDatabasesApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		ListFederatedDatabasesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true"

Response examples (200)

[
  {
    "cloudProviderConfig": {
      "aws": {
        "externalId": "string",
        "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
        "iamUserARN": "string",
        "roleId": "32b6e34b3d91647abb20e7b8"
      },
      "azure": {
        "atlasAppId": "string",
        "roleId": "32b6e34b3d91647abb20e7b8",
        "servicePrincipalId": "string",
        "tenantId": "string"
      },
      "gcp": {
        "gcpServiceAccount": "string",
        "roleId": "32b6e34b3d91647abb20e7b8"
      }
    },
    "dataProcessRegion": {
      "cloudProvider": "AWS",
      "": "SYDNEY_AUS"
    },
    "groupId": "32b6e34b3d91647abb20e7b8",
    "hostnames": [
      "string"
    ],
    "name": "string",
    "privateEndpointHostnames": [
      {
        "hostname": "string",
        "privateEndpoint": "string"
      }
    ],
    "state": "UNVERIFIED",
    "storage": {
      "databases": [
        {
          "collections": [
            {
              "dataSources": [
                {
                  "allowInsecure": false,
                  "collection": "string",
                  "collectionRegex": "string",
                  "database": "string",
                  "databaseRegex": "string",
                  "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
                  "datasetPrefix": "string",
                  "defaultFormat": ".avro",
                  "path": "string",
                  "provenanceFieldName": "string",
                  "storeName": "string",
                  "trimLevel": 42,
                  "urls": [
                    "string"
                  ]
                }
              ],
              "name": "string"
            }
          ],
          "maxWildcardCollections": 100,
          "name": "string",
          "views": [
            {
              "name": "string",
              "pipeline": "string",
              "source": "string"
            }
          ]
        }
      ],
      "stores": [
        {
          "name": "string",
          "provider": "object",
          "additionalStorageClasses": [
            "STANDARD"
          ],
          "bucket": "string",
          "delimiter": "string",
          "includeTags": false,
          "prefix": "string",
          "public": false,
          "region": "US_GOV_WEST_1"
        }
      ]
    }
  }
]

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Federated Database Instance and Online Archive Private Endpoints in One Project

GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds

Service accounts Digest auth

Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles.

Path parameters

groupId string Required

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

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

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

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
includeCount boolean

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

Default value is true.
itemsPerPage integer

Number of items that the response returns per page.

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

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

Minimum value is 1. Default value is 1.
pretty boolean

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

Default value is false.

Prettyprint

Responses

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

OK
Hide response attributes Show response attributes object
- 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.
- results array[object]
  
  List of returned documents that MongoDB Cloud provides when completing this request.
  
  Hide results attributes Show results attributes object
  
  azureLinkId string
  
  Link ID that identifies the Azure private endpoint connection.
  
  comment string
  
  Human-readable string to associate with this private endpoint.
  
  customerEndpointDNSName string
  
  Human-readable label to identify customer's VPC endpoint DNS name. If defined, you must also specify a value for region.
  
  customerEndpointIPAddress string
  
  IP address used to connect to the Azure private endpoint.
  
  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}$.
  
  endpointId string Required
  
  Unique 22-character alphanumeric string that identifies the private endpoint.
  
  Format should match the following pattern: ^vpce-[0-9a-f]{17}$.
  
  Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature
  
  errorMessage string
  
  Error message describing a failure approving the private endpoint request.
  
  provider string
  
  Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.
  
  Value is AWS. Default value is AWS.
  
  region string
  
  Human-readable label to identify the region of customer's VPC endpoint. If defined, you must also specify a value for customerEndpointDNSName.
  
  status string
  
  Status of the private endpoint connection request.
  
  Values are PENDING, OK, FAILED, or DELETING.
  
  type string
  
  Human-readable label that identifies the resource type associated with this private endpoint.
  
  Value is DATA_LAKE. Default value is DATA_LAKE.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
  
  Minimum value is 0.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
401 application/json

Unauthorized.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
403 application/json

Forbidden.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
404 application/json

Not Found.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

GET /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds

atlas api listDataFederationPrivateEndpoints --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListDataFederationPrivateEndpointsApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		ListDataFederationPrivateEndpointsWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "azureLinkId": "string",
      "comment": "string",
      "customerEndpointDNSName": "string",
      "customerEndpointIPAddress": "string",
      "endpointId": "vpce-3bf78b0ddee411ba1",
      "errorMessage": "string",
      "provider": "AWS",
      "region": "US_EAST_1",
      "status": "PENDING",
      "type": "DATA_LAKE"
    }
  ],
  "totalCount": 42
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return One Data Lake Pipeline Deprecated

GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}

Service accounts Digest auth

Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

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

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,64}$.

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
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- createdDate string(date-time)
  
  Timestamp that indicates when the Data Lake Pipeline was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- datasetRetentionPolicy object
  
  Dataset Retention Policy for a Scheduled Data Lake Pipeline.
  
  Hide datasetRetentionPolicy attributes Show datasetRetentionPolicy attributes object
  
  lastModifiedDate string(date-time)
  
  Date when retention policy was last modified. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  units string Required
  
  Quantity of time in which the Data Lake Pipeline measures dataset retention.
  
  Values are DAYS, WEEKS, or MONTHS.
  
  value integer(int32) Required
  
  Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.
  
  Minimum value is 1.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the group.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lastUpdatedDate string(date-time)
  
  Timestamp that indicates the last time that the Data Lake Pipeline was updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- name string
  
  Name of this Data Lake Pipeline.
- sink object
  
  Atlas Data Lake Storage as the destination for a Data Lake Pipeline.
  
  Hide sink attributes Show sink attributes object
  
  type string Discriminator
  
  Type of ingestion destination of this Data Lake Pipeline.
  
  Value is DLS.
  
  metadataProvider string
  
  Target cloud provider for this Data Lake Pipeline.
  
  Value is AWS.
  
  metadataRegion string
  
  Target cloud provider region for this Data Lake Pipeline.
  
  Supported cloud provider regions
  
  partitionFields array[object]
  
  Ordered fields used to physically organize data in the destination.
  
  Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.
  
  Hide partitionFields attributes Show partitionFields attributes object
  
  fieldName string Required
  
  Human-readable label that identifies the field name used to partition data.
  
  Maximum length is 700.
  
  order integer(int32) Required
  
  Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero.
  
  Default value is 0.
- source object
  
  One of:
  OnDemandCpsSnapshotSource object PeriodicCpsSnapshotSource object
  
  On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is ON_DEMAND_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is PERIODIC_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  policyItemId string
  
  Unique 24-hexadecimal character string that identifies a policy item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- state string
  
  State of this Data Lake Pipeline.
  
  Values are ACTIVE or PAUSED.
- transformations array[object]
  
  Fields to be excluded for this Data Lake Pipeline.
  
  Field Transformations during ingestion of a Data Lake Pipeline.
  
  Hide transformations attributes Show transformations attributes object
  
  field string
  
  Key in the document.
  
  type string
  
  Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
  
  Value is EXCLUDE.
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.

GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}

atlas api getPipeline --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.GetPipelineApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		GetPipelineWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true"

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "createdDate": "2025-05-04T09:42:00Z",
  "datasetRetentionPolicy": {
    "lastModifiedDate": "2025-05-04T09:42:00Z",
    "units": "DAYS",
    "value": 42
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedDate": "2025-05-04T09:42:00Z",
  "name": "string",
  "sink": {
    "type": "DLS",
    "metadataProvider": "AWS",
    "metadataRegion": "string",
    "partitionFields": [
      {
        "fieldName": "string",
        "order": 0
      }
    ]
  },
  "source": {
    "type": "PERIODIC_CPS",
    "clusterName": "string",
    "collectionName": "string",
    "databaseName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8"
  },
  "state": "ACTIVE",
  "transformations": [
    {
      "field": "string",
      "type": "EXCLUDE"
    }
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove One Data Lake Pipeline Deprecated

DELETE /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}

Service accounts Digest auth

Removes one Data Lake Pipeline.

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

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,64}$.

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.

Responses

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

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

DELETE /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}

atlas api deletePipeline --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.DeletePipelineApiParams{}
	httpResp, err := client.DataLakePipelinesApi.
		DeletePipelineWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}"

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Ingestion Schedules for One Data Lake Pipeline Deprecated

GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules

Service accounts Digest auth

Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

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

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,64}$.

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
Hide response attributes Show response attributes object
- frequencyInterval integer(int32) Required
  
  Number that indicates the frequency interval for a set of Snapshots. A value of 1 specifies the first instance of the corresponding frequencyType.
  
  In a yearly policy item, 1 indicates that the yearly Snapshot occurs on the first day of January and 12 indicates the first day of December.
  
  In a monthly policy item, 1 indicates that the monthly Snapshot occurs on the first day of the month and 40 indicates the last day of the month.
  
  In a weekly policy item, 1 indicates that the weekly Snapshot occurs on Monday and 7 indicates Sunday.
  
  In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only 12 as the frequency interval value.
  
  MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.
  
  Values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, or 40.
- frequencyType string Required
  
  Human-readable label that identifies the frequency type associated with the backup policy.
  
  Values are daily, hourly, weekly, monthly, yearly, or ondemand.
- id string
  
  Unique 24-hexadecimal digit string that identifies this backup policy item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- retentionUnit string Required
  
  Unit of time in which MongoDB Cloud measures Snapshot retention.
  
  Values are days, weeks, months, or years.
- retentionValue integer(int32) Required
  
  Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.
  
  For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.
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.

GET /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules

atlas api listPipelineSchedules --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListPipelineSchedulesApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		ListPipelineSchedulesWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true"

Response examples (200)

[
  {
    "frequencyInterval": 1,
    "frequencyType": "daily",
    "id": "32b6e34b3d91647abb20e7b8",
    "retentionUnit": "days",
    "retentionValue": 42
  }
]

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Pause One Data Lake Pipeline Deprecated

POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause

Service accounts Digest auth

Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

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

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,64}$.

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
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- createdDate string(date-time)
  
  Timestamp that indicates when the Data Lake Pipeline was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- datasetRetentionPolicy object
  
  Dataset Retention Policy for a Scheduled Data Lake Pipeline.
  
  Hide datasetRetentionPolicy attributes Show datasetRetentionPolicy attributes object
  
  lastModifiedDate string(date-time)
  
  Date when retention policy was last modified. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  units string Required
  
  Quantity of time in which the Data Lake Pipeline measures dataset retention.
  
  Values are DAYS, WEEKS, or MONTHS.
  
  value integer(int32) Required
  
  Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.
  
  Minimum value is 1.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the group.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lastUpdatedDate string(date-time)
  
  Timestamp that indicates the last time that the Data Lake Pipeline was updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- name string
  
  Name of this Data Lake Pipeline.
- sink object
  
  Atlas Data Lake Storage as the destination for a Data Lake Pipeline.
  
  Hide sink attributes Show sink attributes object
  
  type string Discriminator
  
  Type of ingestion destination of this Data Lake Pipeline.
  
  Value is DLS.
  
  metadataProvider string
  
  Target cloud provider for this Data Lake Pipeline.
  
  Value is AWS.
  
  metadataRegion string
  
  Target cloud provider region for this Data Lake Pipeline.
  
  Supported cloud provider regions
  
  partitionFields array[object]
  
  Ordered fields used to physically organize data in the destination.
  
  Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.
  
  Hide partitionFields attributes Show partitionFields attributes object
  
  fieldName string Required
  
  Human-readable label that identifies the field name used to partition data.
  
  Maximum length is 700.
  
  order integer(int32) Required
  
  Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero.
  
  Default value is 0.
- source object
  
  One of:
  OnDemandCpsSnapshotSource object PeriodicCpsSnapshotSource object
  
  On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is ON_DEMAND_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Type of ingestion source of this Data Lake Pipeline.
  
  Value is PERIODIC_CPS.
  
  clusterName string
  
  Human-readable name that identifies the cluster.
  
  collectionName string
  
  Human-readable name that identifies the collection.
  
  databaseName string
  
  Human-readable name that identifies the database.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  policyItemId string
  
  Unique 24-hexadecimal character string that identifies a policy item.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- state string
  
  State of this Data Lake Pipeline.
  
  Values are ACTIVE or PAUSED.
- transformations array[object]
  
  Fields to be excluded for this Data Lake Pipeline.
  
  Field Transformations during ingestion of a Data Lake Pipeline.
  
  Hide transformations attributes Show transformations attributes object
  
  field string
  
  Key in the document.
  
  type string
  
  Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
  
  Value is EXCLUDE.
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.

POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause

atlas api pausePipeline --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.PausePipelineApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		PausePipelineWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \
  -d '{ <Payload> }'

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "createdDate": "2025-05-04T09:42:00Z",
  "datasetRetentionPolicy": {
    "lastModifiedDate": "2025-05-04T09:42:00Z",
    "units": "DAYS",
    "value": 42
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedDate": "2025-05-04T09:42:00Z",
  "name": "string",
  "sink": {
    "type": "DLS",
    "metadataProvider": "AWS",
    "metadataRegion": "string",
    "partitionFields": [
      {
        "fieldName": "string",
        "order": 0
      }
    ]
  },
  "source": {
    "type": "PERIODIC_CPS",
    "clusterName": "string",
    "collectionName": "string",
    "databaseName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8"
  },
  "state": "ACTIVE",
  "transformations": [
    {
      "field": "string",
      "type": "EXCLUDE"
    }
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Trigger On-Demand Snapshot Ingestion Deprecated

POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger

Service accounts Digest auth

Triggers a Data Lake Pipeline ingestion of a specified snapshot.

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

Human-readable label that identifies the Data Lake Pipeline.

Format should match the following pattern: ^[^/\\ "$]{1,64}$.

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

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

Body Required

Triggers a single ingestion run of a snapshot.

datasetRetentionPolicy object

Dataset Retention Policy for a Scheduled Data Lake Pipeline.
Hide datasetRetentionPolicy attributes Show datasetRetentionPolicy attributes object
- units string Required
  
  Quantity of time in which the Data Lake Pipeline measures dataset retention.
  
  Values are DAYS, WEEKS, or MONTHS.
- value integer(int32) Required
  
  Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.
  
  Minimum value is 1.
snapshotId string Required

Unique 24-hexadecimal character string that identifies the snapshot.

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

Responses

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

OK
Hide response attributes Show response attributes object
- _id string
  
  Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- backupFrequencyType string
  
  Backup schedule interval of the Data Lake Pipeline.
  
  Values are HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY, or ON_DEMAND.
- createdDate string(date-time)
  
  Timestamp that indicates when the pipeline run was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- datasetName string
  
  Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a dataSource in a Federated Database collection.
- datasetRetentionPolicy object
  
  Dataset Retention Policy for a Scheduled Data Lake Pipeline.
  
  Hide datasetRetentionPolicy attributes Show datasetRetentionPolicy attributes object
  
  lastModifiedDate string(date-time)
  
  Date when retention policy was last modified. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  units string Required
  
  Quantity of time in which the Data Lake Pipeline measures dataset retention.
  
  Values are DAYS, WEEKS, or MONTHS.
  
  value integer(int32) Required
  
  Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.
  
  Minimum value is 1.
- groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lastUpdatedDate string(date-time)
  
  Timestamp that indicates the last time that the pipeline run was updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- phase string
  
  Processing phase of the Data Lake Pipeline.
  
  Values are SNAPSHOT, EXPORT, or INGESTION.
- pipelineId string
  
  Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- scheduledDeletionDate string(date-time)
  
  Timestamp that indicates when the pipeline run will expire and its dataset will be deleted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- snapshotId string
  
  Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- state string
  
  State of the pipeline run.
  
  Values are PENDING, IN_PROGRESS, DONE, FAILED, or DATASET_DELETED.
- stats object
  
  Runtime statistics for this Data Lake Pipeline run.
  
  Hide stats attributes Show stats attributes object
  
  bytesExported integer(int64)
  
  Total data size in bytes exported for this pipeline run.
  
  numDocs integer(int64)
  
  Number of docs ingested for a this pipeline run.
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.

POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger

atlas api triggerSnapshotIngestion --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.TriggerSnapshotIngestionApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		TriggerSnapshotIngestionWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \
  -d '{ <Payload> }'

Request examples

{
  "datasetRetentionPolicy": {
    "units": "DAYS",
    "value": 42
  },
  "snapshotId": "32b6e34b3d91647abb20e7b8"
}

Response examples (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "backupFrequencyType": "HOURLY",
  "createdDate": "2025-05-04T09:42:00Z",
  "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  "datasetRetentionPolicy": {
    "lastModifiedDate": "2025-05-04T09:42:00Z",
    "units": "DAYS",
    "value": 42
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedDate": "2025-05-04T09:42:00Z",
  "phase": "SNAPSHOT",
  "pipelineId": "32b6e34b3d91647abb20e7b8",
  "scheduledDeletionDate": "2025-05-04T09:42:00Z",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "state": "PENDING",
  "stats": {
    "bytesExported": 42,
    "numDocs": 42
  }
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Create One Identity Provider

POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders

Service accounts Digest auth

Creates one identity provider within the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.

Note: This resource only supports the creation of OIDC identity providers.

Path parameters

federationSettingsId string Required

Unique 24-hexadecimal digit string that identifies your federation.

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.

application/vnd.atlas.2023-11-15+json

Body object Required

The identity provider that you want to create.

audience string

Identifier of the intended recipient of the token.
authorizationType string

Indicates whether authorization is granted based on group membership or user ID.

Values are GROUP or USER.
description string

The description of the identity provider.
displayName string

Human-readable label that identifies the identity provider.

Minimum length is 1, maximum length is 50.
groupsClaim string

Identifier of the claim which contains IdP Group IDs in the token.
idpType string

String enum that indicates the type of the identity provider. Default is WORKFORCE.

Values are WORKFORCE or WORKLOAD.
issuerUri string

Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
protocol string

String enum that indicates the protocol of the identity provider. Either SAML or OIDC.

Values are SAML or OIDC.
userClaim string

Identifier of the claim which contains the user ID in the token.
associatedDomains array[string]

List that contains the domains associated with the identity provider.
clientId string

Client identifier that is assigned to an application by the Identity Provider.
requestedScopes array[string]

Scopes that MongoDB applications will request from the authorization endpoint.

audience string

Identifier of the intended recipient of the token.
authorizationType string

Indicates whether authorization is granted based on group membership or user ID.

Values are GROUP or USER.
description string

The description of the identity provider.
displayName string

Human-readable label that identifies the identity provider.

Minimum length is 1, maximum length is 50.
groupsClaim string

Identifier of the claim which contains IdP Group IDs in the token.
idpType string

String enum that indicates the type of the identity provider. Default is WORKFORCE.

Values are WORKFORCE or WORKLOAD.
issuerUri string

Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
protocol string

String enum that indicates the protocol of the identity provider. Either SAML or OIDC.

Values are SAML or OIDC.
userClaim string

Identifier of the claim which contains the user ID in the token.

Responses

200 application/vnd.atlas.2023-11-15+json

OK
One of:
FederationOidcWorkforceIdentityProvider object FederationOidcWorkloadIdentityProvider object
Hide attributes Show attributes

associatedOrgs array[object]

List that contains the connected organization configurations associated with the identity provider.

Hide associatedOrgs attributes Show associatedOrgs attributes object

dataAccessIdentityProviderIds array[string]

The collection of unique ids representing the identity providers that can be used for data access in this organization.

domainAllowList array[string]

Approved domains that restrict users who can join the organization based on their email address.

domainRestrictionEnabled boolean Required

Value that indicates whether domain restriction is enabled for this connected org.

identityProviderId string

Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.

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

orgId string Required

Unique 24-hexadecimal digit string that identifies the connected organization configuration.

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

postAuthRoleGrants array[string]

Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.

Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.

roleMappings array[object]

Role mappings that are configured in this organization.

Mapping settings that link one IdP and MongoDB Cloud.

Hide roleMappings attributes Show roleMappings attributes object

externalGroupName string Required

Unique human-readable label that identifies the identity provider group to which this role mapping applies.

Minimum length is 1, maximum length is 200.

id string

Unique 24-hexadecimal digit string that identifies this role mapping.

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

roleAssignments array[object]

Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.

Hide roleAssignments attributes Show roleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.

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

role string

Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.

Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

userConflicts array[object]

List that contains the users who have an email address that doesn't match any domain on the allowed list.

MongoDB Cloud user linked to this federated authentication.

Hide userConflicts attributes Show userConflicts attributes object

emailAddress string(email) Required

Email address of the MongoDB Cloud user linked to the federated organization.

federationSettingsId string Required

Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.

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

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

userId string

Unique 24-hexadecimal digit string that identifies this user.

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

audience string

Identifier of the intended recipient of the token.

authorizationType string

Indicates whether authorization is granted based on group membership or user ID.

Values are GROUP or USER.

createdAt string(date-time)

Date that the identity provider was created on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

The description of the identity provider.

displayName string

Human-readable label that identifies the identity provider.

groupsClaim string

Identifier of the claim which contains IdP Group IDs in the token.

id string Required

Unique 24-hexadecimal digit string that identifies the identity provider.

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

idpType string

String enum that indicates the type of the identity provider. Default is WORKFORCE.

Values are WORKFORCE or WORKLOAD.

issuerUri string

Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.

oktaIdpId string Required

Legacy 20-hexadecimal digit string that identifies the identity provider.

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

protocol string

String enum that indicates the protocol of the identity provider. Either SAML or OIDC.

Values are SAML or OIDC.

updatedAt string(date-time)

Date that the identity provider was last updated on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

userClaim string

Identifier of the claim which contains the user ID in the token.

associatedDomains array[string]

List that contains the domains associated with the identity provider.

clientId string

Client identifier that is assigned to an application by the Identity Provider.

requestedScopes array[string]

Scopes that MongoDB applications will request from the authorization endpoint.
Hide attributes Show attributes

associatedOrgs array[object]

List that contains the connected organization configurations associated with the identity provider.

Hide associatedOrgs attributes Show associatedOrgs attributes object

dataAccessIdentityProviderIds array[string]

The collection of unique ids representing the identity providers that can be used for data access in this organization.

domainAllowList array[string]

Approved domains that restrict users who can join the organization based on their email address.

domainRestrictionEnabled boolean Required

Value that indicates whether domain restriction is enabled for this connected org.

identityProviderId string

Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.

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

orgId string Required

Unique 24-hexadecimal digit string that identifies the connected organization configuration.

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

postAuthRoleGrants array[string]

Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.

Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, or ORG_READ_ONLY.

roleMappings array[object]

Role mappings that are configured in this organization.

Mapping settings that link one IdP and MongoDB Cloud.

Hide roleMappings attributes Show roleMappings attributes object

externalGroupName string Required

Unique human-readable label that identifies the identity provider group to which this role mapping applies.

Minimum length is 1, maximum length is 200.

id string

Unique 24-hexadecimal digit string that identifies this role mapping.

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

roleAssignments array[object]

Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective orgId. Each element in the array can have a value for orgId or groupId, but not both.

Hide roleAssignments attributes Show roleAssignments attributes object

groupId string

Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within roleAssignments can have a value for groupId or orgId, but not both.

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within roleAssignments can have a value for orgId or groupId, but not both.

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

role string

Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.

Values are ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_READ_ONLY, GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR, or GROUP_STREAM_PROCESSING_OWNER.

userConflicts array[object]

List that contains the users who have an email address that doesn't match any domain on the allowed list.

MongoDB Cloud user linked to this federated authentication.

Hide userConflicts attributes Show userConflicts attributes object

emailAddress string(email) Required

Email address of the MongoDB Cloud user linked to the federated organization.

federationSettingsId string Required

Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.

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

firstName string Required

First or given name that belongs to the MongoDB Cloud user.

lastName string Required

Last name, family name, or surname that belongs to the MongoDB Cloud user.

userId string

Unique 24-hexadecimal digit string that identifies this user.

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

audience string

Identifier of the intended recipient of the token.

authorizationType string

Indicates whether authorization is granted based on group membership or user ID.

Values are GROUP or USER.

createdAt string(date-time)

Date that the identity provider was created on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

The description of the identity provider.

displayName string

Human-readable label that identifies the identity provider.

groupsClaim string

Identifier of the claim which contains IdP Group IDs in the token.

id string Required

Unique 24-hexadecimal digit string that identifies the identity provider.

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

idpType string

String enum that indicates the type of the identity provider. Default is WORKFORCE.

Values are WORKFORCE or WORKLOAD.

issuerUri string

Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.

oktaIdpId string Required

Legacy 20-hexadecimal digit string that identifies the identity provider.

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

protocol string

String enum that indicates the protocol of the identity provider. Either SAML or OIDC.

Values are SAML or OIDC.

updatedAt string(date-time)

Date that the identity provider was last updated on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

userClaim string

Identifier of the claim which contains the user ID in the token.
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.

POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders

atlas api createIdentityProvider --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.CreateIdentityProviderApiParams{}
	sdkResp, httpResp, err := client.FederatedAuthenticationApi.
		CreateIdentityProviderWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
  -d '{ <Payload> }'

Request examples

{
  "audience": "string",
  "authorizationType": "GROUP",
  "description": "string",
  "displayName": "string",
  "groupsClaim": "string",
  "idpType": "WORKFORCE",
  "issuerUri": "urn:idp:default",
  "protocol": "SAML",
  "userClaim": "string",
  "associatedDomains": [
    "string"
  ],
  "clientId": "string",
  "requestedScopes": [
    "string"
  ]
}

{
  "audience": "string",
  "authorizationType": "GROUP",
  "description": "string",
  "displayName": "string",
  "groupsClaim": "string",
  "idpType": "WORKFORCE",
  "issuerUri": "urn:idp:default",
  "protocol": "SAML",
  "userClaim": "string"
}

Response examples (200)

{
  "associatedOrgs": [
    {
      "dataAccessIdentityProviderIds": [
        "string"
      ],
      "domainAllowList": [
        "string"
      ],
      "domainRestrictionEnabled": true,
      "identityProviderId": "string",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "postAuthRoleGrants": [
        "ORG_OWNER"
      ],
      "roleMappings": [
        {
          "externalGroupName": "string",
          "id": "32b6e34b3d91647abb20e7b8",
          "roleAssignments": [
            {
              "groupId": "32b6e34b3d91647abb20e7b8",
              "orgId": "32b6e34b3d91647abb20e7b8",
              "role": "ORG_OWNER"
            }
          ]
        }
      ],
      "userConflicts": [
        {
          "emailAddress": "hello@example.com",
          "federationSettingsId": "32b6e34b3d91647abb20e7b8",
          "firstName": "string",
          "lastName": "string",
          "userId": "32b6e34b3d91647abb20e7b8"
        }
      ]
    }
  ],
  "audience": "string",
  "authorizationType": "GROUP",
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "displayName": "string",
  "groupsClaim": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "idpType": "WORKFORCE",
  "issuerUri": "string",
  "oktaIdpId": "string",
  "protocol": "SAML",
  "updatedAt": "2025-05-04T09:42:00Z",
  "userClaim": "string",
  "associatedDomains": [
    "string"
  ],
  "clientId": "string",
  "requestedScopes": [
    "string"
  ]
}

{
  "associatedOrgs": [
    {
      "dataAccessIdentityProviderIds": [
        "string"
      ],
      "domainAllowList": [
        "string"
      ],
      "domainRestrictionEnabled": true,
      "identityProviderId": "string",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "postAuthRoleGrants": [
        "ORG_OWNER"
      ],
      "roleMappings": [
        {
          "externalGroupName": "string",
          "id": "32b6e34b3d91647abb20e7b8",
          "roleAssignments": [
            {
              "groupId": "32b6e34b3d91647abb20e7b8",
              "orgId": "32b6e34b3d91647abb20e7b8",
              "role": "ORG_OWNER"
            }
          ]
        }
      ],
      "userConflicts": [
        {
          "emailAddress": "hello@example.com",
          "federationSettingsId": "32b6e34b3d91647abb20e7b8",
          "firstName": "string",
          "lastName": "string",
          "userId": "32b6e34b3d91647abb20e7b8"
        }
      ]
    }
  ],
  "audience": "string",
  "authorizationType": "GROUP",
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "displayName": "string",
  "groupsClaim": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "idpType": "WORKFORCE",
  "issuerUri": "string",
  "oktaIdpId": "string",
  "protocol": "SAML",
  "updatedAt": "2025-05-04T09:42:00Z",
  "userClaim": "string"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return All Flex Clusters from One Project

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

Service accounts Digest auth

Returns details for all flex clusters in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

Path parameters

groupId string Required

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

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

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

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
includeCount boolean

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

Default value is true.
itemsPerPage integer

Number of items that the response returns per page.

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

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

Minimum value is 1. Default value is 1.
pretty boolean

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

Default value is false.

Prettyprint

Responses

200 application/vnd.atlas.2024-11-13+json

OK
Hide response attributes Show response attributes object
- 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.
- results array[object]
  
  List of returned documents that MongoDB Cloud provides when completing this request.
  
  Group of settings that configure a MongoDB Flex cluster.
  
  Hide results attributes Show results attributes object
  
  backupSettings object
  
  Flex backup configuration.
  
  Hide backupSettings attribute Show backupSettings attribute object
  
  enabled boolean
  
  Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.
  
  Default value is true.
  
  Flex Cluster Backups
  
  clusterType string
  
  Flex cluster topology.
  
  Value is REPLICASET. Default value is REPLICASET.
  
  connectionStrings object
  
  Collection of Uniform Resource Locators that point to the MongoDB database.
  
  Connection string URI format
  
  Hide connectionStrings attributes Show connectionStrings attributes object
  
  standard string
  
  Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
  
  Connection String URI Format
  
  standardSrv string
  
  Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.
  
  Connection String URI Format
  
  createDate string(date-time)
  
  Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
  
  groupId string
  
  Unique 24-hexadecimal character string that identifies the project.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  id string
  
  Unique 24-hexadecimal digit string that identifies the instance.
  
  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 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.
  
  mongoDBVersion string
  
  Version of MongoDB that the instance runs.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
  
  name string
  
  Human-readable label that identifies the instance.
  
  Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
  
  providerSettings object Required
  
  Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
  
  Hide providerSettings attributes Show providerSettings attributes object
  
  backingProviderName string
  
  Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
  
  Values are AWS, AZURE, or GCP.
  
  diskSizeGB number(double)
  
  Storage capacity available to the flex cluster expressed in gigabytes.
  
  providerName string
  
  Human-readable label that identifies the provider type.
  
  Value is FLEX. Default value is FLEX.
  
  regionName string
  
  Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.
  
  stateName string
  
  Human-readable label that indicates the current operating condition of this instance.
  
  Values are IDLE, CREATING, UPDATING, DELETING, or REPAIRING.
  
  tags array[object]
  
  List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
  
  Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
  
  Resource Tags
  
  Hide tags attributes Show tags attributes object
  
  key string Required
  
  Constant that defines the set of the tag. For example, environment in the environment : production tag.
  
  Minimum length is 1, maximum length is 255.
  
  value string Required
  
  Variable that belongs to the set of the tag. For example, production in the environment : production tag.
  
  Minimum length is 1, maximum length is 255.
  
  terminationProtectionEnabled boolean
  
  Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
  
  Default value is false.
  
  versionReleaseSystem string
  
  Method by which the cluster maintains the MongoDB versions.
  
  Value is LTS. Default value is LTS.
- totalCount integer(int32)
  
  Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.
  
  Minimum value is 0.
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.
409 application/json

Conflict.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- badRequestDetail object
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

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

atlas api listFlexClusters --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.ListFlexClustersApiParams{}
	sdkResp, httpResp, err := client.FlexClustersApi.
		ListFlexClustersWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"

Response examples (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "backupSettings": {
        "enabled": true
      },
      "clusterType": "REPLICASET",
      "connectionStrings": {
        "standard": "string",
        "standardSrv": "string"
      },
      "createDate": "2025-05-04T09:42:00Z",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBVersion": "string",
      "name": "string",
      "providerSettings": {
        "backingProviderName": "AWS",
        "diskSizeGB": 42.0,
        "providerName": "FLEX",
        "regionName": "string"
      },
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "versionReleaseSystem": "LTS"
    }
  ],
  "totalCount": 42
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return One Legacy Backup Snapshot Deprecated

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

Service accounts Digest auth

Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation.

Cloud Backup Documentation

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-]*$.
snapshotId string Required

Unique 24-hexadecimal digit string that identifies the desired snapshot.

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
Hide response attributes Show response attributes object
- clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- clusterName string
  
  Human-readable label that identifies the cluster.
- complete boolean
  
  Flag that indicates whether the snapshot exists. This flag returns false while MongoDB Cloud creates the snapshot.
- created object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide created attributes Show created attributes object
  
  date string(date-time)
  
  Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- doNotDelete boolean
  
  Flag that indicates whether someone can delete this snapshot. You can't set "doNotDelete" : true and set a timestamp for expires in the same request.
- expires string(date-time)
  
  Date and time when MongoDB Cloud deletes the snapshot. If "doNotDelete" : true, MongoDB Cloud removes any value set for this parameter. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- groupId string
  
  Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- id string
  
  Unique 24-hexadecimal digit string that identifies the snapshot.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- incremental boolean
  
  Flag indicating if this is an incremental or a full snapshot.
- lastOplogAppliedTimestamp object
  
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
  
  Hide lastOplogAppliedTimestamp attributes Show lastOplogAppliedTimestamp attributes object
  
  date string(date-time)
  
  Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  increment integer(int32)
  
  Order of the database operation that the oplog recorded at specific date and time.
  
  Minimum value is 1199145600.
- 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.
- parts array[object]
  
  Metadata that describes the complete snapshot.
  
  For a replica set, this array contains a single document.
  
  For a sharded cluster, this array contains one document for each shard plus one document for the config host.
  
  Characteristics that identify this snapshot.
  
  Hide parts attributes Show parts attributes object
  
  clusterId string
  
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  completedTime string(date-time)
  
  Date and time when the snapshot completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
  
  compressionSetting string
  
  Human-readable label that identifies the method of compression for the snapshot.
  
  Values are NONE or GZIP.
  
  dataSizeBytes integer(int64)
  
  Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.
  
  encryptionEnabled boolean
  
  Flag that indicates whether someone encrypted this snapshot.
  
  fcv string
  
  Number that indicates the feature compatibility version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  fileSizeBytes integer(int64)
  
  Number that indicates the total size of the data files in bytes.
  
  machineId string
  
  Hostname and port that indicate the node on which MongoDB Cloud created the snapshot.
  
  Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
  
  masterKeyUUID string(uuid)
  
  Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when "parts.encryptionEnabled" : true.
  
  mongodVersion string
  
  Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.
  
  Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).
  
  replicaSetName string
  
  Human-readable label that identifies the replica set.
  
  replicaState string
  
  The node's role at the time when snapshot process began.
  
  storageSizeBytes integer(int64)
  
  Number that indicates the total size of space allocated for document storage.
  
  typeName string
  
  Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.
  
  Values are REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET, or CONFIG_SHARD_REPLICA_SET.
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.

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

atlas api getLegacySnapshot --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.GetLegacySnapshotApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		GetLegacySnapshotWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"

Response examples (200)

{
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "complete": true,
  "created": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "incremental": true,
  "lastOplogAppliedTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "parts": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "completedTime": "2025-05-04T09:42:00Z",
      "compressionSetting": "NONE",
      "dataSizeBytes": 42,
      "encryptionEnabled": true,
      "fcv": "string",
      "fileSizeBytes": 42,
      "machineId": "string",
      "masterKeyUUID": "string",
      "mongodVersion": "string",
      "replicaSetName": "string",
      "replicaState": "string",
      "storageSizeBytes": 42,
      "typeName": "REPLICA_SET"
    }
  ]
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Return One MongoDB Cloud User by Username Deprecated

GET /api/atlas/v2/users/byName/{userName}

Service accounts Digest auth

Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the Return One Organization API Key endpoint. To use this resource, the requesting Service Account or API Key can have any role.

Return One Organization API Key

Path parameters

userName string Required

Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.

Format should match the following pattern: ^[a-z0-9!#$%&'*+/=?^_{|}~-]+(?:.[a-z0-9!#$%&'+/=?^_`{|}~-]+)@(?:a-z0-9?.)+a-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.2023-01-01+json

OK
Hide response attributes Show response attributes object
- country string Required
  
  Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
  
  Format should match the following pattern: ^([A-Z]{2})$.
- createdAt string(date-time)
  
  Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.
- emailAddress string(email) Required Deprecated
  
  Email address that belongs to the MongoDB Cloud user.
- firstName string Required
  
  First or given name that belongs to the MongoDB Cloud user.
- id string
  
  Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
- lastAuth string(date-time)
  
  Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
- lastName string Required
  
  Last name, family name, or surname that belongs to the MongoDB Cloud user.
- 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.
- mobileNumber string Required
  
  Mobile phone number that belongs to the MongoDB Cloud user.
  
  Format should match the following pattern: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.
- password string(password) Required
  
  Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.
  
  Minimum length is 8.
- roles array[object]
  
  List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.
  
  MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.
  
  Hide roles attributes Show roles attributes object
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleName string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  Values are ORG_MEMBER, ORG_READ_ONLY, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER, or GROUP_DATABASE_ACCESS_ADMIN.
- teamIds array[string]
  
  List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
  
  Format of each should match the following pattern: ^([a-f0-9]{24})$.
- username string(email) Required
  
  Email address that represents the username of the MongoDB Cloud user.
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.

GET /api/atlas/v2/users/byName/{userName}

atlas api getUserByUsername --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

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

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

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

	params = &sdk.GetUserByUsernameApiParams{}
	sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
		GetUserByUsernameWithParams(ctx, params).
		Execute()
}

curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true"

Response examples (200)

{
  "country": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "emailAddress": "hello@example.com",
  "firstName": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com"
}

Response examples (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

Remove One Alert Configuration from One Project

Path parameters

Query parameters

Responses

Acknowledge One Alert from One Project

Path parameters

Query parameters

Body Required

Responses

Create One Atlas Search Index Deprecated

Path parameters

Query parameters

Body object Required

tokenizer object Required

Responses

tokenizer object Required

Create Search Nodes

Path parameters

Query parameters

Body Required

Responses

Remove One Atlas Search Index by Name

Path parameters

Query parameters

Responses

Auditing

Create One Snapshot Export Bucket

Path parameters

Query parameters

Body object Required

Responses

Remove All Cloud Backup Schedules

Path parameters

Query parameters

Responses

Take One On-Demand Snapshot

Path parameters

Query parameters

Body Required

Responses

Return All Sharded Cluster Cloud Backups

Path parameters

Query parameters

Responses

Remove One Link-Token

Path parameters

Query parameters

Responses

Return All Cloud Provider Access Roles

Path parameters

Query parameters

Responses

Deauthorize One Cloud Provider Access Role

Path parameters

Query parameters

Responses

Remove One Cluster from One Project

Path parameters

Query parameters

Responses

Load Sample Dataset into One Cluster

Path parameters

Query parameters

Responses

Return Status of Sample Dataset Load for One Cluster

Path parameters

Query parameters

Responses

Collection Level Metrics

Return Cluster-Level Query Latency

Path parameters

Query parameters

Responses

Return All Federated Database Instances in One Project

Path parameters

Query parameters

Responses

region string Required

Return All Federated Database Instance and Online Archive Private Endpoints in One Project

Path parameters