Skip to main content
Update pipeline name/description
curl --request PATCH \
  --url https://api.ionworks.com/pipelines/{pipeline_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "user_id": "<string>",
  "description": "<string>",
  "options": {
    "live_progress_updates": true
  },
  "error": "<string>",
  "created_by_email": "<string>"
}

Path Parameters

​
pipeline_id
string
required

Body

application/json
​
name
string | null
Minimum string length: 1
​
description
string | null

Response

Successful Response

Model for representing a pipeline in API list responses (without elements).

​
id
string
required
​
project_id
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
canceled
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
organization_id
string
required

Organization this pipeline belongs to.

​
user_id
string | null
​
description
string | null
​
options
PipelineOptions · object

Options for pipeline execution behavior.

​
error
string | null
​
error_code
enum<string> | null

Machine-readable error codes for jobs.

Available options:
CONFIGURATION_ERROR,
SOLVER_ERROR,
EXECUTION_TIMEOUT,
SUBMISSION_FAILED,
INTERNAL_ERROR
​
created_by_email
string | null