IBM Orchestration Pipelines API | IBM Cloud API Docs

Introduction

Last updated: 2024-05-08

IBM Orchestration Pipelines is a orchestration solution for data scientists to automate and share their machine learning lifecycles.

Endpoint URLs

https://api.dataplatform.cloud.ibm.com

https://{cpd_cluster_host}

Authentication

Before you can call an IBM Orchestration Pipelines API you must first create an IAM bearer token. Each token is valid only for one hour, and after a token expires you must create a new one if you want to continue using the API. The recommended method to retrieve a token programmatically is to create an API key for your IBM Cloud identity and then use the IAM token API to exchange that key for a token.

You can create a token in IBM Cloud or by using the IBM Cloud command line interface (CLI).

To create a token in the IBM Cloud:

Log in to IBM Cloud and select Manage > Access (IAM) > API keys.
Create an API key for your own personal identity, copy the key value, and save it in a secure place. After you leave the page, you will no longer be able to access this value.
With your API key, set up Postman or another REST API tool and run the following command to the right

You can read more about managing API keys at Understanding API keys documentation page. Visit the Generating an IBM Cloud IAM token by using an API key

A bearer token from IBM Cloud Pak for Data is required to use any of the Watson Data APIs.

Visit the Generating a bearer token on Cloud Pak for Data for more information.

Uploads a pipeline file and create a new pipeline. You need to specify either project_id or space_id.

POST /apis/v1/pipelines/upload

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

name
string
Name of the pipeline, defaults to file's name.

Possible values: 1 ≤ length ≤ 255, Value must match regular expression ^[\w-]*$
description
string
Description of the pipelines, defaults to "".

Possible values: 0 ≤ length ≤ 65535, Value must match regular expression ^.*$
volatile
boolean
When set to true, indicates the new pipeline's default version will be work-in-progress.

Work-in-progress pipeline versions can be updated (with this flag still set to true) multiple times before committed as finished state.

Form Parameters

uploadfile
Required*
binary
Pipeline file to be uploaded.

The supported file formats are pipeline.json and zip which contains pipeline.json inside, with content-type being absent, equal to "application/json" or "application/zip".

Response

Response Body

ApiPipeline

Pipeline

Status Code

200
Pipeline was created
default
New pipeline creation result

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555",
  "created_at": "2024-06-03T12:30:57Z",
  "name": "pipeline-name",
  "description": "Pipeline description"
}

Uploads a pipeline file and creates a new pipeline version (or updates a volatile one). You need to specify either project_id or space_id.

POST /apis/v1/pipelines/upload_version

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

name
string
Name of the pipeline, defaults to file's name.

Possible values: 1 ≤ length ≤ 255, Value must match regular expression ^[\w-]*$
pipeline_id
string
ID of the pipeline the version should be attached to.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
volatile
boolean
When set to true, indicates the version is or will be work-in-progress.

Work-in-progress pipeline versions can be updated (with this flag still set to true) multiple times before committed as finished state.

If it's used while the default version is already volatile, it updates that version instead of creating a new one.

If it's not used while a volatile version is the default one, upload will fail with error

Form Parameters

uploadfile
Required*
binary
Pipeline file to be uploaded.

The supported file formats are pipeline.json and zip which contains pipeline.json inside, with content-type being absent, equal to "application/json" or "application/zip".

Response

Response Body

ApiPipelineVersion

Pipeline version

Status Code

200
New pipeline version was created or updated.
default
Upload a pipeline file result

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555-0",
  "name": "pipeline_name",
  "created_at": "2024-06-04T08:32:56Z"
}

Commits a pre-existing volatile default version to finished state. You need to specify either project_id or space_id.

POST /apis/v1/pipelines/commit

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

pipeline_id
Required*
string
ID of the pipeline the version is attached to.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Request Body

CommitRequestBody

Commit request

Response

Response Body

ApiPipeline

Pipeline

Status Code

200
Pre-existing volatile default version was successfully committed
default
Result of commit a pre-existing volatile default version

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555",
  "created_at": "2024-06-03T12:30:57Z",
  "name": "pipeline-name",
  "description": "Pipeline description"
}

Validates a pipeline file

POST /apis/v1/pipelines/validate

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Form Parameters

uploadfile
Required*
binary
Pipeline file to be uploaded.

The supported file formats are pipeline.json and zip which contains pipeline.json inside, with content-type being absent, equal to "application/json" or "application/zip".

Response

Response Body

OftExceptions

Exceptions

Status Code

200
Pipeline file validation has passed
default
Pipeline file validation result

No Sample Response

This method does not specify any sample responses.

Creates a new pipeline from existing pipeline. You need to specify either project_id or space_id.

POST /apis/v1/pipelines/copy

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Request Body

Required*

CopyRequestBody

Copy request

Response

Response Body

ApiPipeline

Pipeline

Status Code

200
New pipeline was created
default
Result of creation a new pipeline from existing one

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555",
  "created_at": "2024-06-03T12:30:57Z",
  "name": "pipeline-name",
  "description": "Pipeline description"
}

Finds all pipelines. You need to specify either project_id or space_id.

GET /apis/v1/pipelines

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

page_token
string
A page token to request the next page of results. The token is acquired from the nextPageToken field of the response from the previous ListPipelines call.
page_size
integer
The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field.
sort_by
string
Accepted formats: "field_name" or "field_name sort_order". Accepted field names: "id", "name", "created_at". Accepted sort orders: "asc" (ascending), "desc" (descending). Default sort order is "asc".

Response

Response Body

ApiPipelineCollection

List of pipeline runs

Status Code

200
Pipelines were retrieved successfully. Response can contain smaller number of resources than requested in some cases.
default
Result of retrieving all pipelines.

No Sample Response

This method does not specify any sample responses.

Finds a specific pipeline by ID. You need to specify either project_id or space_id.

GET /apis/v1/pipelines/{pipeline_id}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

pipeline_id
Required*
string
The ID of the pipeline to be retrieved.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response Body

ApiPipeline

Pipeline

Status Code

200
Pipeline was found
default
Pipeline search result

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555",
  "created_at": "2024-06-03T12:30:57Z",
  "name": "pipeline-name",
  "description": "Pipeline description"
}

Deletes a pipeline and its pipeline versions. You need to specify either project_id or space_id.

DELETE /apis/v1/pipelines/{pipeline_id}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

pipeline_id
Required*
string
The ID of the pipeline to be deleted.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Status Code

204
Pipeline versions were deleted.
default
Result of pipeline deletion.

No Sample Response

This method does not specify any sample responses.

Lists all pipeline versions of a given pipeline. You need to specify either project_id or space_id.

GET /apis/v1/pipeline_versions

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

resource_key.id
Required*
string
The ID of the pipeline
page_size
int32
The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page.
page_token
string
A page token to request the next page of results. The token is acquired from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page.
sort_by
string
Can be format of "field_name", "field_name asc" or "field_name desc" Ascending by default.

Response

Response Body

ApiPipelineVersionCollection

List of pipelines

Status Code

200
Pipeline versions were retrieved. Response can contain smaller number of resources than requested in some cases.
default
Result of pipeline versions retrieval.

No Sample Response

This method does not specify any sample responses.

Gets a pipeline version by pipeline version ID. You need to specify either project_id or space_id.

GET /apis/v1/pipeline_versions/{version_id}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

version_id
Required*
string
The ID of the pipeline version to be retrieved.

Response

Response Body

ApiPipelineVersion

Pipeline version

Status Code

200
Pipeline version was read
default
Result of retrieving pipeline version

Example responses

Status 200

{
  "id": "11111111-2222-3333-4444-555555555555-0",
  "name": "pipeline_name",
  "created_at": "2024-06-04T08:32:56Z"
}

Deletes a pipeline version by pipeline version ID. You need to specify either project_id or space_id.

DELETE /apis/v1/pipeline_versions/{version_id}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

version_id
Required*
string
The ID of the pipeline version to be deleted.

Response

Status Code

204
Pipeline version was deleted.
default
Result of pipeline version deletion

No Sample Response

This method does not specify any sample responses.

Returns code (YAML template, Orchestration Flow json) that contains the specified pipeline's description, parameters and metadata. You need to specify either project_id or space_id.

GET /apis/v1/pipelines/{pipeline_id}/templates

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

pipeline_id
Required*
string
The ID of the pipeline whose template is to be retrieved

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

format
string
What code should be get.

Allowable values: [template,flow,all]
Default: template
version
string
The version of the pipeline to be retrieved. One of:
- 'any' (return the volatile version if it exists, and the latest non-volatile version otherwise).
- 'latest' (retrieve the latest non-volatile version), or
- 'volatile' (retrieve the volatile version),
Allowable values: [any,latest,volatile]

Response

Response Body

ApiGetTemplateJsonResponseCollection

Pipeline template

Status Code

200
Code (YAML template, Orchestration Flow json) was returned successfully
default
Result of returning code (YAML template, Orchestration Flow json)

No Sample Response

This method does not specify any sample responses.

Returns code (YAML template, Orchestration Flow json embedded in a string) that contains the specified pipeline version's description, parameters and metadata. You need to specify either project_id or space_id.

GET /apis/v1/pipeline_versions/{version_id}/templates

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

version_id
Required*
string
The ID of the pipeline version whose template is to be retrieved

Query Parameters

format
string
What code should be get.

Allowable values: [template,flow,all]
Default: template

Response

Response Body

ApiGetTemplateJsonResponseCollection

Pipeline template

Status Code

200
Code (YAML template, Orchestration Flow json) was returned successfully.
default
Result of retrieving code (YAML template, Orchestration Flow json)

No Sample Response

This method does not specify any sample responses.

Returns code (YAML template, Orchestration Flow json) that contains the specified pipeline version's description, parameters and metadata.

GET /apis/v1/pipeline_versions/{version_id}/templates/{format}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

version_id
Required*
string
The ID of the pipeline version whose template is to be retrieved
format
Required*
string
What code should be get.

Allowable values: [template,flow]

Response

Response Body

ApiGetTemplateJsonResponse

Pipeline template

Status Code

200
Code (YAML template, Orchestration Flow json) was returned successfully.
default
Result of retrieving code (YAML template, Orchestration Flow json)

No Sample Response

This method does not specify any sample responses.

Finds a specific run by ID. You need to specify either project_id or space_id.

GET /apis/v1/runs/{run_id}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response Body

ApiRunDetail

Run details

Status Code

200
Run was found
default
Result of run search

No Sample Response

This method does not specify any sample responses.

Lists parameters of the run

GET /apis/v1/runs/{run_id}/parameters

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response Body

ApiRunParameters

Run parameters and parameter sets

Status Code

200
A successful response.
default
Results of the run parameters.

No Sample Response

This method does not specify any sample responses.

Gets execution log for given task run name. You need to specify either project_id or space_id.

GET /apis/v1/runs/{run_id}/logs/{task_run_name}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
task_run_name
Required*
string
Name of executed TaskRun or Run

Possible values: 1 ≤ length ≤ 255, Value must match regular expression ^[\w-]*$
Example: pipeline-90bc031ef1009d53527cf454db0160ed3cca-run-bash-script-1

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response Body

string

Log content

Status Code

200
Artifact data
default
Error

Example responses

Execution completed.

Finds logs related to the specified run. You need to specify either project_id or space_id.

GET /apis/v1/runs/{run_id}/logs

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
filter
string
An url-encoded, JSON-serialized Filter protocol buffer

Response

Response Body

ApiReadRunLogsResponse

List of run logs

Status Code

200
Logs were found

No Sample Response

This method does not specify any sample responses.

Gets artifact on path from the specified run.

GET /apis/v1/runs/{run_id}/artifacts/{artifact_path}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
artifact_path
Required*
string
The artifact path relative to run storage location.

Example: pipeline-b9eb6393-control-user-variables/outputs/variables-x

Response

Response Body

ApiReadArtifactResponse

Artifact content

Status Code

200
A successful response.

No Sample Response

This method does not specify any sample responses.

Gets information about all task results given by TaskRun or Run name

GET /apis/v1/runs/{run_id}/tasks/{task_run_name}/results

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
task_run_name
Required*
string
Name of the TaskRun or Run from which the results come from e.g. pipeline-90bc031ef1009d53527cf454db0160ed3cca-run-bash-script-1

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_id
string
Pipeline ID

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_run_name
string
Pipeline run name

Response

Response Body

ApiTaskResultCollection

Task results

Status Code

200
Information about task was read
default
Result of retrieving information about task

No Sample Response

This method does not specify any sample responses.

Gets metadata about task result given by output name and TaskRun or Run name

HEAD /apis/v1/runs/{run_id}/tasks/{task_run_name}/results/{name}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
task_run_name
Required*
string
Name of the TaskRun or Run from which the results come from e.g. pipeline-90bc031ef1009d53527cf454db0160ed3cca-run-bash-script-1
name
Required*
string
Name of the result e.g. env-variables

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_id
string
Pipeline ID

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_run_name
string
Pipeline run name

Response

Response Headers

Content-Hash
string
SHA-256 hash calculated for the content of the output file.
Content-Type
string
Indicates the media type of the resource

Status Code

200
OK
default
Get metadata about task result given by output name and TaskRun or Run name

Gets information about task result given by output name and TaskRun or Run name

GET /apis/v1/runs/{run_id}/tasks/{task_run_name}/results/{name}

Request

Custom Headers

Space-ID
string
The id of the space

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Project-ID
string
The id of the project

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path Parameters

run_id
Required*
string
The ID of the run.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
task_run_name
Required*
string
Name of the TaskRun or Run from which the results come from e.g. pipeline-90bc031ef1009d53527cf454db0160ed3cca-run-bash-script-1
name
Required*
string
Name of the result e.g. env-variables

Query Parameters

job_id
string
The ID of the job related to run. Adding this may improve response time.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_id
string
Pipeline ID

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
pipeline_run_name
string
Pipeline run name

Response

Response Body

ApiTaskResult

Task result

Status Code

200
Information about task result was read
default
Result of retrieving information about task

No Sample Response

This method does not specify any sample responses.

Introduction

Endpoint URLs

Authentication

Methods

Uploads a pipeline file and create a new pipeline

Request

Custom Headers

Space-ID

Project-ID

Query Parameters

name

description

volatile

Form Parameters

uploadfile

Response

Response Body

id

created_at

name

description

parameters

default_version

error

Status Code

200

default

Creates a new pipeline version (or updates a volatile one)

Request

Custom Headers

Space-ID

Project-ID

Query Parameters

name

pipeline_id

volatile

Form Parameters

uploadfile

Response

Response Body

id

name

created_at

parameters

code_source_url

package_url

resource_references

Status Code

200

default

Commits a pre-existing volatile default version to finished state

Request

Custom Headers

Space-ID

Project-ID

Query Parameters

pipeline_id

Request Body

commit_message

Response

Response Body

id

created_at

name

description

parameters

default_version

error

Status Code

200

default

Validates a pipeline file

Request

Custom Headers

Space-ID

Project-ID

Form Parameters

uploadfile

Response

Response Body