Introduction 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://{cpdclusterhost} Authentication Before you can call an IBM Orchestration Pipelines API you must first create an IAMhttps://cloud.ibm.com/docs/account?topic=account-iamoverview 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: 1. Log in to IBM Cloudhttps://cloud.ibm.com/ and select Manage Access IAM API keys. 2. 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. 3. 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 keyshttps://cloud.ibm.com/docs/account?topic=account-manapikey documentation page. Visit the Generating an IBM Cloud IAM token by using an API keyhttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey A bearer token from IBM Cloud Pak for Data is required to use any of the Watson Data APIs. Visit the Generating a bearer tokenhttps://www.ibm.com/docs/en/cloud-paks/cp-data/4.8.x?topic=token-generating-bearer on Cloud Pak for Data for more information.
| Method | Path | Summary |
|---|---|---|
| POST | /apis/v1/pipelines/upload | Uploads a pipeline file and create a new pipeline |
| POST | /apis/v1/pipelines/upload_version | Creates a new pipeline version (or updates a volatile one) |
| POST | /apis/v1/pipelines/commit | Commits a pre-existing volatile default version to finished state |
| POST | /apis/v1/pipelines/validate | Validates a pipeline file |
| POST | /apis/v1/pipelines/copy | Creates a new pipeline from existing pipeline |
| GET | /apis/v1/pipelines | Finds all pipelines |
| GET | /apis/v1/pipelines/{pipeline_id} | Finds a specific pipeline by ID |
| DELETE | /apis/v1/pipelines/{pipeline_id} | Deletes a pipeline and its pipeline versions |
| GET | /apis/v1/pipeline_versions | Lists all pipeline versions of a given pipeline |
| GET | /apis/v1/pipeline_versions/{version_id} | Gets a pipeline version by pipeline version ID |
| DELETE | /apis/v1/pipeline_versions/{version_id} | Deletes a pipeline version by pipeline version ID |
| GET | /apis/v1/pipelines/{pipeline_id}/templates | Gets templates for pipeline |
| GET | /apis/v1/pipeline_versions/{version_id}/templates | Gets templates for pipeline version |
| GET | /apis/v1/pipeline_versions/{version_id}/templates/{format} | Gets templates in specified format |
| GET | /apis/v1/runs/{run_id} | Finds a specific run by ID |
| GET | /apis/v1/runs/{run_id}/parameters | Lists parameters of the run |
| GET | /apis/v1/runs/{run_id}/logs/{task_run_name} | Gets log for given task run name |
| GET | /apis/v1/runs/{run_id}/logs | Finds logs related to the specified run |
| GET | /apis/v1/runs/{run_id}/artifacts/{artifact_path} | Gets artifact on path from the specified run |
| GET | /apis/v1/runs/{run_id}/tasks/{task_run_name}/results | Gets information about all task results |
| HEAD | /apis/v1/runs/{run_id}/tasks/{task_run_name}/results/{name} | Gets metadata about task result |
| GET | /apis/v1/runs/{run_id}/tasks/{task_run_name}/results/{name} | Gets information about task result |