Updated on 2026-04-10 GMT+08:00

Obtaining a Project Branch

Function

This API is used to obtain a project branch.

Debugging

You can debug this API in API Explorer which supports automatic authentication. API Explorer automatically generates sample SDK code and provides the debug function.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v1/{project_id}/git/repos/{namespace}/{project}/branches

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant's project ID. See Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

namespace

Yes

String

Definition

Namespace ID. See Obtaining a Repository Namespace.

Range

N/A

Default Value

N/A

project

Yes

String

Definition

Repository project ID. If the value contains a slash (/), replace it with a colon (:). See Obtaining All Projects in a Namespace.

Range

N/A

Default Value

N/A

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type (or format).

Constraints

N/A

Range

application/json;charset=utf8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Repo-Auth

Yes

String

Definition

Authorization name. See Obtaining a Git Repository Authorization List.

Range

N/A

Default Value

N/A

Response

Table 3 Response parameter

Parameter

Type

Description

branches

Array of strings

Definition

Project branch.

Range

N/A

Example Request

None

Example Response

{
  "branches": [
    "main"
  ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

See ServiceStage Error Codes.