POST
/
ext
/
create_pipeline_run

Body

api_key
string
required

This is the API key for your account. You can obtain this from the “Secrets” tab of your “Settings” page.

project
string
required

This is the id of the project the pipeline run will reside in. You can obtain this from the URL of the project page.

pipeline_id
string
required

This is the id of the pipeline to be run. You can obtain this from the table on the first tab of the pipeline modal.

pipeline_version
string
required

This is the version of the pipeline associated with this run. This is the name of the version indicated in the verison dropdown. The default version is “Version 1”.

name
string
required

This is the name of the pipeline run to be created.

description
string
required

This is the description of the pipeline run to be created.

run_date
string

This is the date the pipeline run was run (MM/DD/YYYY). If not provided, the current date will be used.

steps
[Steps]

An array of steps indicating the information to be logged for each step in the pipeline for this run.

Response

status
number

Indicates whether the call was successful. 200 if successful, 400 if not.

message
string

Message saying “Pipeline run created successfuly” if successful, an error message if not.