Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtains the content of a specified file in a specified branch of a repository.

Updated on 2023-09-12 GMT+08:00

View PDF

Obtains the content of a specified file in a specified branch of a repository.

Function

URI

GET /v1/repositories/{repository_uuid}/branch/{branch_name}/file

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_uuid	Yes	String	Specifies the repository ID.
branch_name	Yes	String	Branch Name

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
path	Yes	String	File path.

Request Parameters

**Table 3** Request header 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

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	FilesResponseInfo object	Result
status	String	Status code in a response

**Table 5** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 6** FilesResponseInfo
Parameter	Type	Description
file_name	String	File Name
file_path	String	Path
size	String	File size
encoding	String	Encoding Type
ref	String	Branch name.
blob_id	String	File block ID.
file_type	String	File Type
content	String	File content.

Example Requests

GET https://{endpoint}/v1/repositories/{repository_uuid}/branch/{branch_name}/file

Example Responses

Status code: 200

{
  "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"
}