Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Updating Details of a YAML Pipeline
Updated on 2025-09-08 GMT+08:00

Updating Details of a YAML Pipeline

Function

This API is used to update the details of a YAML pipeline.

Calling Method

For details, see Calling APIs.

URI

PUT /v6/{domain_id}/api/pac/pipelines/{pipeline_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

pipeline_id

Yes

String

Pipeline ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Project ID.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Name.

description

No

String

Description.

push_to_repo

No

Boolean

Whether to push the code to a repository.

new_branch

No

Boolean

Branch name.

new_file

No

Boolean

Whether to create a file.

file_content

No

String

File content.

selected_branch

No

String

Selected branch.

push_branch

No

String

Name of the branch to be pushed.

commit_message

No

String

Commit message.

create_pull_request

No

Boolean

Whether to create a pull request.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pipelineId

String

Pipeline ID.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.