Updating a File
Function
This API is used to modify the repository IP address whitelist.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
PUT https://{hostURL}/v4/repositories/{repository_id}/repository/file
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| repository_id | Yes | Integer | Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A. Value range: 1~2147483647 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| file_path | Yes | String | Definition File path. Range 1–10,000 characters. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Username |
| file_path | Yes | String | File path |
| branch | Yes | String | Branch name |
| commit_message | Yes | String | Commit message |
| author_email | No | String | Author email |
| author_name | No | String | Author name |
| content | Yes | String | File content |
| encoding | No | String | Encoding format |
| last_commit_id | No | String | Latest commit |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| file_path | String | File path |
| branch | String | Branch name |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
PUT https://{endpoint}/v4/repositories/12344/repository/files/123
{
"branch" : "master",
"content" : "123",
"commit_message" : "123",
"file_path" : "a/b/c"
} Example Responses
Status code: 200
OK
{
"branch" : "master",
"file_path" : "123"
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
