v5

latestOpenAPI 3.1.0MITraw.githubusercontent.com2025-07-24172759.4 KB

Pipelines

Update a pipeline

Update the details of a pipeline by ID

post/v4/pipelines/{id}

Path parameters

idstring uuid required

Pipeline UUID

Example:123e4567-e89b-12d3-a456-426614174000

Pipeline UUID

Request body

displayNamestring nullable

Pipeline display name

folderIdstring uuid nullable

Folder UUID

isArchivedboolean

Whether the pipeline is archived

Example request

{
  "displayName": "My Awesome Pipeline",
  "folderId": "6527747a-ba86-441a-aebd-1ad94460bc89"
}

Response

Successful response

idstring uuid required

Pipeline UUID

createdAtstring required

Creation timestamp (ISO 8601)

updatedAtstring required

Last update timestamp (ISO 8601)

slugstring required

Pipeline slug

displayNamestring nullable required

Pipeline display name

folderIdstring uuid nullable required

Folder UUID

archivedAtstring nullable required

Archive timestamp (ISO 8601)

goldenDatasetIdstring uuid nullable required

Golden dataset UUID

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z",
  "slug": "my-awesome-pipeline",
  "displayName": "My Awesome Pipeline",
  "folderId": "6527747a-ba86-441a-aebd-1ad94460bc89",
  "archivedAt": "2025-04-01T00:00:00.000Z",
  "goldenDatasetId": "6527747a-ba86-441a-aebd-1ad94460bc89"
}