Updated on 2025-11-28 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 describes the parameters.

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

namespace

Yes

String

Namespace ID. See Obtaining a Repository Namespace.

project

Yes

String

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

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

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 a token, see Obtaining a User Token Through Password Authentication.

X-Repo-Auth

Yes

String

Authorization name. See Obtaining a Git Repository Authorization List.

Response

Table 3 Response parameter

Parameter

Type

Description

branches

Array<String>

Project branch.

Example Request

None

Example Response

{
  "branches": [
    "main"
  ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

See ServiceStage Error Codes.