Obtaining the Content of a Single Repository File

This API is used to obtain the content of a single repository file.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET https://{hostURL}/v4/repositories/{repository_id}/repository/files/raw

**Table 1** Path Parameters
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
file_path	Yes	String	Definition File path. Range 1–10,000 characters.
ref	No	String	Definition Reference, which can be a branch name, label name, or commit ID. If this parameter is not transferred, the default branch is used. Range 1–2,000 characters.

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

Status code: 200

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

GET https://{endpoint}/v4/repositories/2112029050/repository/files/raw?file_path=12.txt&ref=master

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Parent topic: File

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.