atlas api dataLakePipelines listPipelineRuns

On this page

experimental: Returns a list of past Data Lake Pipeline runs.

To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPipelineRuns'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns

Syntax

Command Syntax

atlas api dataLakePipelines listPipelineRuns [options]

Name	Type	Required	Description
--createdBefore	string	false	if specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for listPipelineRuns
--includeCount		false	flag that indicates whether the response returns the total number of items (totalCount) in the response
--itemsPerPage	int	false	number of items that the response returns per page
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pageNum	int	false	number of the page that displays the current set of the total objects that the response returns
--pipelineName	string	true	human-readable label that identifies the Data Lake Pipeline
--pretty		false	flag that indicates whether the response body should be in the prettyprint format
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Back

getPipelineRun

listPipelineSchedules