Skip to main content
PATCH
/
pipelines
/
{id}
Update pipeline
curl --request PATCH \
  --url https://api.sevalla.com/v3/pipelines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "My Pipeline",
  "type": "trunk",
  "stage_order": [
    {
      "stage_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
      "order": 1
    }
  ],
  "project_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657"
}
'
{
  "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "company_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "project_id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "display_name": "My Pipeline",
  "type": "trunk",
  "stages": [
    {
      "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
      "display_name": "Production",
      "type": "standard",
      "order": 1
    }
  ],
  "created_at": "2025-01-30T00:00:00.000Z",
  "updated_at": "2025-01-30T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Pipeline identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Body

application/json
​
display_name
string

New display name for the pipeline

Required string length: 1 - 255
Example:

"My Pipeline"

​
type
enum<string>

Pipeline type. trunk - all stages share the same Git repository and branch configuration. branch - each stage can have its own branch.

Available options:
trunk,
branch
Example:

"trunk"

​
stage_order
object[]

Reorder stages by providing each stage ID with its new position

​
project_id
string<uuid> | null

Assign the pipeline to a project, or pass null to remove the project assignment

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Response

Default Response

​
id
string<uuid>
required

Unique identifier for the pipeline

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
company_id
string<uuid>
required

Identifier of the company that owns this pipeline

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
project_id
string<uuid> | null
required

Identifier of the project this pipeline is grouped under

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
display_name
string
required

Human-readable name for the pipeline shown in the dashboard

Example:

"My Pipeline"

​
type
enum<string>
required

Pipeline type. trunk - all stages share the same Git repository and branch configuration. branch - each stage can have its own branch.

Available options:
trunk,
branch
Example:

"trunk"

​
stages
object[]
required

Pipeline stages ordered by position

​
created_at
string<date-time>
required

Timestamp when the pipeline was created, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"

​
updated_at
string<date-time>
required

Timestamp when the pipeline was last modified, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"