Viewing File Attributes and Content

Function

This API is used to view file attributes and content.

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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.
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

**Table 4** Response header parameters
Parameter	Type	Description
X-Total	String	View file attributes and content.

**Table 5** Response body parameters
Parameter	Type	Description
name	String	File name
path	String	File path
size	Long	File size Value range: 1~9007199254740992
encoding	String	File encoding format
ref	String	Branch name, tag name, or commit ID
blob_id	String	File identifier
file_type	String	File type
commit	RepositoryCommitDto object	Commit
content	String	File content
is_limited	Boolean	Definition Whether a file is restricted. Range false: the file is not restricted. true: the file is restricted.
content_sha256	String	SHA256 value
last_commit_id	String	Latest commit ID
nick_name	String	User alias
tenant_name	String	Tenant name
user_name	String	Username

**Table 6** RepositoryCommitDto
Parameter	Type	Description
id	String	id
message	String	Message
parent_ids	Array of strings	Parent node commit ID
authored_date	String	Time when the branch was created.
author_name	String	Creator name
author_email	String	Creator's email.
committed_date	String	Code commit date and time
committer_name	String	Committer name
committer_email	String	Committer email
open_gpg_verified	Boolean	Whether to enable the GPG verification
verification_status	Integer	Verification status Value range: 0~1
gpg_primary_key_id	String	Identifier of the GPG public key
name	String	Username
gpg_nick_name	String	Alias
gpg_tenant_name	String	Tenant name
gpg_user_name	String	Information about a specific GPG user

Status code: 401

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

Status code: 403

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

Status code: 404

**Table 9** 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/file?file_path=2112016471&ref=master

Example Responses

Status code: 200

View file attributes and content.

{
  "name" : "README.md",
  "path" : "README.md",
  "size" : 52,
  "encoding" : "base64",
  "ref" : "main",
  "blob_id" : "****",
  "file_type" : "text/plain; charset=utf-8",
  "commit" : {
    "id" : "****",
    "message" : "****",
    "parent_ids" : [ "****" ],
    "authored_date" : "2025-01-14T02:56:17.000Z",
    "author_name" : "CodeHub_beta_dev",
    "author_email" : "liujian@example.com",
    "committed_date" : "2025-01-14T02:56:17.000Z",
    "committer_name" : "****",
    "committer_email" : "****",
    "open_gpg_verified" : null,
    "verification_status" : null,
    "gpg_primary_key_id" : null,
    "name" : null,
    "gpg_nick_name" : null,
    "gpg_tenant_name" : null,
    "gpg_user_name" : null
  },
  "content" : "****",
  "is_limited" : false,
  "content_sha256" : "****",
  "last_commit_id" : "****",
  "nick_name" : "****",
  "tenant_name" : "****",
  "user_name" : "****"
}

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	View file attributes and content.
401	Unauthorized
403	Bad Request
404	Not Found

Error Codes

See Error Codes.

Parent topic: File

Previous topic: Obtaining the Readme File Content of the Default Branch of the Repository

Next topic: Deleting a File

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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

The system is busy. Please try again later.