MOmongodb
Data Lake Pipelines

Create One Data Lake Pipeline

Creates one Data Lake Pipeline.

post/api/atlas/v2/groups/{groupId}/pipelines

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

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.

Query parameters

envelopeboolean

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.

Request body

_idstring

Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.

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

groupIdstring

Unique 24-hexadecimal digit string that identifies the group.

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

namestring

Name of this Data Lake Pipeline.

state'ACTIVE' | 'PAUSED'

State of this Data Lake Pipeline.

Example request

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "groupId": "32b6e34b3d91647abb20e7b8"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.