PUT
/
pipelines
/
{id}

Updates pipeline name and / or description.

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
required

The name or ID of the pipeline to retrieve.

Body

application/json

A pipeline is an object containing source and target schemas, and associated with a mapper that jobs can be executed on.

name
string | null
required

The name of the pipeline. Must be unique within the organization.

description
string | null

The description of the pipeline

Response

200 - application/json

A pipeline is an object containing source and target schemas, and associated with a mapper that jobs can be executed on.

id
string
required

The id of the pipeline

user_id
string
required

The user id of the pipeline

name
string
required

The name of the pipeline. Must be unique within the organization.

description
string | null

The description of the pipeline

target_schema_id
string
required

The id of the target schema associated with the pipeline

source_schema_id
string | null

The id of the source schema associated with the pipeline

last_status
string | null

The status of the last job run on this pipeline.

updated_at
string | null
required

The date and time this pipeline was last updated

created_at
string
required

The date and time this pipeline was created