Obtains the content of a specified file in a specified branch of a repository.
Function
Obtains the content of a specified file in a specified branch of a repository.
URI
GET /v1/repositories/{repository_uuid}/branch/{branch_name}/file
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
repository_uuid |
Yes |
String |
Specifies the repository ID. |
branch_name |
Yes |
String |
Branch Name |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
path |
Yes |
String |
File path. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error |
Error object |
Response error. |
result |
FilesResponseInfo object |
Result |
status |
String |
Status code in a response |
Example Requests
GET https://{endpoint}/v1/repositories/{repository_uuid}/branch/{branch_name}/file
Example Responses
Status code: 200
OK
{ "result" : [ { "file_name" : "README.md", "file_path" : "README.md", "size" : 666, "encoding" : "base64", "ref" : "master", "blob_id" : "75c19b5b1904a72c8a9959c98ae6884d0ace0279", "file_type" : "text/plain; charset=utf-8", "content" : "RUVFRUVFRUU=" } ], "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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.