Help Center/ CodeArts Repo/ API Reference/ APIs/ File/ Querying a Files in a Repository

Updated on 2025-03-28 GMT+08:00

View PDF

Querying a Files in a Repository

Function

This API is used to obtain information about a file in a repository, such as the name, size, and content. Note that the file content is encoded using Base64.

URI

GET /v2/projects/{repo_id}/repository/files

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
repo_id	Yes	Integer	Repository short ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
file_path	Yes	String	Complete path of the file.
ref	Yes	String	Commit ID, which is the branch or tag name of the repository.

Request Parameters

**Table 3** 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: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	FileContentInfo object	File details.
status	String	Response status.

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

**Table 6** FileContentInfo
Parameter	Type	Description
file_name	String	File name.
file_path	String	File path.
size	Integer	File size.
encoding	String	File encoding.
content_sha256	String	SHA256-encoded file content.
ref	String	Branch name.
blob_id	String	blob sha
commit_id	String	SHA ID of a commit.
last_commit_id	String	SHA ID of the last commit.
content	String	Base64-encoded file content.

Example Requests

GET https://{endpoint}/v2/projects/859341/repository/files?README.md&ref=master

Example Responses

Status code: 200

{
  "result" : {
    "size" : 9,
    "encoding" : "base64",
    "ref" : "master",
    "content" : "NDU0NTQ1NDQ1",
    "file_name" : "README.md",
    "file_path" : "README.md",
    "content_sha256" : "e16f4f6c41a79d120484774a625bea8a3c3dcb655aa7c7e793ac48639dc63944",
    "blob_id" : "3325fa3142fd66fedc8c3a5218b417f561e0ea2f",
    "commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3",
    "last_commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3"
  },
  "status" : "success"
}