How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Data Lake Pipelines API

Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.

MongoDB Data Lake Pipelines API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Lake Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 13 operations across 9 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

13 operations 9 paths 17 schemas 2 DELETE6 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Data Lake Pipelines API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 2 DELETE, 6 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Data Lake Pipelines 13

Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.

GET
/api/atlas/v2/groups/{groupId}/pipelinesdeprecated
Return All Data Lake Pipelines in One Project
listGroupPipelines 2 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/pipelinesdeprecated
Create One Data Lake Pipeline
createGroupPipeline 2 params body → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}deprecated
Remove One Data Lake Pipeline
deleteGroupPipeline 3 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}deprecated
Return One Data Lake Pipeline
getGroupPipeline 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}deprecated
Update One Data Lake Pipeline
updateGroupPipeline 3 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedulesdeprecated
Return All Ingestion Schedules for One Data Lake Pipeline
getGroupPipelineAvailableSchedules 4 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshotsdeprecated
Return All Backup Snapshots for One Data Lake Pipeline
getGroupPipelineAvailableSnapshots 8 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pausedeprecated
Pause One Data Lake Pipeline
pauseGroupPipeline 4 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resumedeprecated
Resume One Data Lake Pipeline
resumeGroupPipeline 4 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runsdeprecated
Return All Data Lake Pipeline Runs in One Project
listGroupPipelineRuns 8 params → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}deprecated
Delete One Pipeline Run Dataset
deleteGroupPipelineRun 5 params → 202400401403404429500
GET
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}deprecated
Return One Data Lake Pipeline Run
getGroupPipelineRun 5 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/triggerdeprecated
Trigger On-Demand Snapshot Ingestion
triggerGroupPipeline 4 params body → 200400401403404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DiskBackupSnapshot (13 properties), IngestionPipelineRun (13 properties), DataLakeIngestionPipeline (10 properties), ApiError (6 properties). Each schema is shown below with its type and property counts.

RequestAccepted
object
Accepted.
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
DatasetRetentionPolicy
object
Dataset Retention Policy for a Scheduled Data Lake Pipeline.
3 properties 2 required
DiskBackupSnapshot
object
13 properties
TriggerIngestionPipelineRequest
object
2 properties 1 required
PipelineRunStats
object
Runtime statistics for this Data Lake Pipeline run.
2 properties
DiskBackupApiPolicyItem
object
Specifications for one policy.
5 properties 4 required
FieldTransformation
object
Field Transformations during ingestion of a Data Lake Pipeline.
2 properties
IngestionPipelineRun
object
Run details of a Data Lake Pipeline.
13 properties
DataLakeIngestionPipeline
object
Details of a Data Lake Pipeline.
10 properties
IngestionSource
object
Ingestion Source of a Data Lake Pipeline.
1 property
PaginatedPipelineRunView
object
3 properties 1 required
IngestionSink
object
Ingestion destination of a Data Lake Pipeline.
1 property
BadRequestDetail
object
Bad request detail.
1 property
PaginatedBackupSnapshotView
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-data-lake-pipelines-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Data Lake Pipelines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.