Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Locking a Repository Based on the Repository Short ID
Updated on 2025-03-28 GMT+08:00
View PDF
Share

Locking a Repository Based on the Repository Short ID

Function

Lock a repository based on the repository short ID.

URI

POST /v4/{project_id}/repositories/{repository_id}/lock

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

repository_id

Yes

String

Repository ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 201

Table 3 Response body parameters

Parameter

Type

Description

locked

Boolean

Lock status.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Response error.

error_code

String

Response error code.

Example Requests

POST https://{endpoint}/v4/{project_id}/repositories/{repository_id}/lock

Example Responses

Status code: 201

OK 
{
    "locked": true
}

Status code: 401

Unauthorized

{
    "error_code": "DEV.00000003"
    "error_msg": "Authentication information expired"
}

Status Code

Status Code

Description

201

OK

401

Unauthorized

Error code.

See Error Codes.

Parent topic: Repository