Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Obtaining the Content of a Single File in the Repository (Downloading a Single File)
Updated on 2026-04-28 GMT+08:00

Obtaining the Content of a Single File in the Repository (Downloading a Single File)

Function

This API is used to obtain the content of a single file in the repository (downloading a single file).

Debugging

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

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/blobs/{blob_id}/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

blob_id

Yes

String

Definition:

Blog file ID You can obtain file information of a repository by calling the API used to query file information of a repository.

Value range:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

file_name

No

String

Definition

Name of the file to be downloaded.

Constraints

N/A

Range

N/A

Default Value

N/A

file_path

Yes

String

Definition

File path.

Range

1–10,000 characters.

Request Parameters

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.

Response Parameters

Status code: 200

OK

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.

Example Requests

GET https://{endpoint}/v4/repositories/2112029050/repository/blobs/1123sadad2/raw?file_path=12.txt

Example Responses

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

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.