Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Obtaining the Readme File Content of the Default Branch of the Repository
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining the Readme File Content of the Default Branch of the Repository

Function

This API is used to obtain the Readme file content of the default branch of the repository.

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/readme-file

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

Request Parameters

Table 2 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

Table 3 Response header parameters

Parameter

Type

Description

X-Total

String

Obtain the Readme file content of the default branch of the repository.
Table 4 Response body parameters

Parameter

Type

Description

blob_id

String

Definition

Blob file ID.

Constraints

N/A

content

String

Definition

File content encoded using Base64.

Constraints

N/A.

encoding

AnyType

Definition

File encoding mode.

Constraints

  • Base64.

Default value:

Base64.

file_name

String

File name

file_path

String

File path

file_type

String

File type

size

Long

Definition

File size (in bytes).

Constraints

N/A.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 7 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/2112015538/repository/readme-file

Example Responses

Status code: 200

Obtain the Readme file content of the default branch of the repository.

{
  "blob_id" : "634be87120b8e9df12bb79f47e1a2c1f1a732848",
  "content" : "IyAwOTExXzE0MzhfY3JlYXRlCgo",
  "encoding" : "base64",
  "file_name" : "README.md",
  "file_path" : "README.md",
  "file_type" : "text/plain; charset=utf-8",
  "size" : 20
}

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

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

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

Obtain the Readme file content of the default branch of the repository.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: File