Pipeline Runs

APIs to manage Pipeline Runs

Get all Runs for the Pipeline

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Responses
200

All Runs for the Pipeline

401

Pipeline run get error

get/v0/pipelines/{pipeline_id}/runs/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Create a Pipeline Run

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

Request Body schema: application/json
object (PipelineRun_POST)
Responses
200

Created Pipeline Run

401

Pipeline run create error

post/v0/pipelines/{pipeline_id}/runs/
Request samples
application/json
{ }
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Get Pipeline run by pipeline run id

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

pipeline_run_id
required
string

Run Id of pipeline run

Responses
200

Get Pipeline run

401

Operation get error

get/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Update a Pipeline Run

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

pipeline_run_id
required
string

Run id of pipeline run

Request Body schema: application/json
status
string
Enum: "queued" "processing" "running" "complete" "success" "failure" "cancelled" "invalid"
Responses
200

Updated Pipeline run information

400

Pipeline Run update error

401

Pipeline Run update error

put/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/
Request samples
application/json
{
  • "status": "queued"
}
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}

Delete a Pipeline Run

Request
Security:
path Parameters
pipeline_id
required
string

ID of the Pipeline

pipeline_run_id
required
string

Run id of pipeline run

Responses
200

Deleted Pipeline run information

400

Pipeline Run update error

401

Pipeline Run update error

delete/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/
Response samples
application/json
{
  • "code": 0,
  • "message": "string",
  • "content": {
    }
}