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.
curl \ --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/pipelines/{pipelineName}' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header "Content-Type: application/json" \ --data '{"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"}]}'{ "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" } ] }{ "_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" } ] }{ "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" }{ "error": 401, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Unauthorized", "errorCode": "NOT_ORG_GROUP_CREATOR" }{ "error": 403, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Forbidden", "errorCode": "CANNOT_CHANGE_GROUP_NAME" }{ "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" }{ "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" }{ "error": 500, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Internal Server Error", "errorCode": "UNEXPECTED_ERROR" }