Toolcog home
Search ⌘ + K

Command Palette

Search for a command to run...

Sign In

Trigger On-Demand Snapshot Ingestion

Deprecated
POST /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger
Copy endpoint
https://cloud.mongodb.com

Triggers a Data Lake Pipeline ingestion of a specified snapshot.

Parameters

path Path Parameters

Name Type
groupId 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.
string
pipelineName required

Human-readable label that identifies the Data Lake Pipeline.
string

query Query Parameters

Name Type
envelope

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

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

Request Body

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

Triggers a single ingestion run of a snapshot.

interface TriggerIngestionPipelineRequest {
datasetRetentionPolicy?: DatasetRetentionPolicy

Dataset Retention Policy for a Scheduled Data Lake Pipeline.

interface DatasetRetentionPolicy {
lastModifiedDate?: string;
units: "DAYS" | "WEEKS" | "MONTHS";
value: number;
}
;
snapshotId: string;
}

Responses

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

OK

interface IngestionPipelineRun {
_id?: string;
backupFrequencyType?: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY" | "ON_DEMAND";
createdDate?: string;
datasetName?: string;
datasetRetentionPolicy?: DatasetRetentionPolicy

Dataset Retention Policy for a Scheduled Data Lake Pipeline.

interface DatasetRetentionPolicy {
lastModifiedDate?: string;
units: "DAYS" | "WEEKS" | "MONTHS";
value: number;
}
;
groupId?: string;
lastUpdatedDate?: string;
phase?: "SNAPSHOT" | "EXPORT" | "INGESTION";
pipelineId?: string;
scheduledDeletionDate?: string;
snapshotId?: string;
state?: "PENDING" | "IN_PROGRESS" | "DONE" | "FAILED" | "DATASET_DELETED";
stats?: PipelineRunStats

Runtime statistics for this Data Lake Pipeline run.

interface PipelineRunStats {
bytesExported?: number;
numDocs?: number;
}
;
}

Client Errors

400 application/json

Bad Request.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
403 application/json

Forbidden.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
404 application/json

Not Found.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}