Update One Data Lake Pipeline Deprecated
Updates one Data Lake Pipeline.
Path parameters
-
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})$. -
Human-readable label that identifies the Data Lake Pipeline.
Format should match the following pattern:
^[^/\\ "$]{1,64}$.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON 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.
PATCH /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}
Atlas CLI
atlas api dataLakePipelines updateGroupPipeline --helpimport ( "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") // See https://dochub.mongodb.org/core/atlas-go-sdk-oauth client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret)) if err != nil { log.Fatalf("Error: %v", err) } params = &sdk.UpdateGroupPipelineApiParams{} sdkResp, httpResp, err := client.DataLakePipelinesApi. UpdateGroupPipelineWithParams(ctx, params). Execute() } curl --include --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}/pipelines/{pipelineName}" \ -d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest --include \ --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}/pipelines/{pipelineName}" \ -d '{ <Payload> }' Request examples
{ "datasetRetentionPolicy": { "units": "DAYS", "value": 42 }, "name": "string", "sink": { "metadataProvider": "AWS", "metadataRegion": "string", "partitionFields": [ { "fieldName": "string", "order": 0 } ], "type": "DLS" }, "source": { "type": "ON_DEMAND_CPS", "clusterName": "string", "collectionName": "string", "databaseName": "string" }, "transformations": [ { "field": "string", "type": "EXCLUDE" } ] } 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": "ON_DEMAND_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 (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" }