Obtaining Branch Details

Function

This API is used to obtain branch details.

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

**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
branch_name	Yes	String	Definition Branch name. Range 1–2,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	Obtain branch details.

**Table 5** Response body parameters
Parameter	Type	Description
name	String	Branch name
commit	CommitDto object	Commit information
merged	Boolean	User ID
protected	Boolean	Protected branch or not
developers_can_push	Boolean	Whether can be pushed by developers
developers_can_merge	Boolean	Whether can be merged by developers
can_push	Boolean	Pushable or not
default	Boolean	Default branch or not

**Table 6** CommitDto
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
short_id	String	Short ID
created_at	String	Creation time
title	String	Title
author_avatar_url	String	author_avatar_url
committer_avatar_url	String	committer_avatar_url
relate_url	Array of RelatedCommitSimpleDto objects	only for DevCloud
nick_name	String	Title
tenant_name	String	tenant_name
user_name	String	Username

**Table 7** RelatedCommitSimpleDto
Parameter	Type	Description
related_id	String	Associated work item ID
related_url	String	Associated work item URL

Status code: 401

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

Status code: 403

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

Status code: 404

**Table 10** 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/branch?branch_name=master

Example Responses

Status code: 200

Obtain branch details.

{
  "name" : "12312312",
  "commit" : {
    "id" : "3e133ffd60e795ce52e092db03ebcc8da43ab471",
    "message" : "Create a file****",
    "parent_ids" : [ "****" ],
    "authored_date" : "2025-02-22T03:11:03.000Z",
    "author_name" : "****",
    "author_email" : "****",
    "committed_date" : "2025-02-22T03:11:03.000Z",
    "committer_name" : "****",
    "committer_email" : "****",
    "short_id" : "****",
    "created_at" : "2025-02-22T03:11:03.000Z",
    "title" : "Create file 123123.",
    "author_avatar_url" : "",
    "committer_avatar_url" : ""
  },
  "merged" : false,
  "protected" : true,
  "developers_can_push" : true,
  "developers_can_merge" : true,
  "can_push" : true,
  "default" : false
}

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 branch details.
401	Unauthorized
403	Bad Request
404	Not Found

Error Codes

See Error Codes.

Parent topic: Refs

Previous topic: Deleting a Tag

Next topic: Deleting a Branch

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.