Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Modifying the Status of a Repository Referenced by a Pipeline
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Modifying the Status of a Repository Referenced by a Pipeline

Function

This API is used to modify the status of a repository referenced by a pipeline.

URI

PUT /v1/repositories/{repository_uuid}/pipeline

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_uuid

Yes

String

Explanation

Repository UUID. For details, see the UUID returned by Querying the Details About a Repository.

Constraints

None

Range

32 digits and letters.

Default value

None

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

None

Range

1–100,000 characters.

Default value

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Explanation

Response error.

Range

None

result

Boolean

Explanation

Response result.

Range

None

status

String

Explanation

Response status.

Range

  • success: The API call is successful.
  • failed: The API call failed.
Table 4 Error

Parameter

Type

Description

code

String

Explanation

Error code.

Range

Max. 100 characters in the error code format.

message

String

Explanation

Error message.

Range

None

Example Requests

PUT https://{endpoint}/v1/repositories/{repository_uuid}/pipeline

Example Responses

Status code: 200

OK

{
  "result" : true,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository