Get branch list

Prev Next

Available in Classic and VPC

Get the list of branches.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/repository/{repositoryName}/branch

Request headers

For information about the headers common to all SourceCommit APIs, see SourceCommit request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
repositoryName String Required Repository name

Request example

The request example is as follows:

curl --location --request GET 'https://sourcecommit.apigw.ntruss.com/api/v1/repository/repository001/branch' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.default String - Default branch name
result.branch Array - Branch list

Response status codes

For information about the HTTP status codes common to all SourceCommit APIs, see SourceCommit response status codes.

Response example

The response example is as follows:

{
    "result": {
        "default": "master",
        "branch": [
            "master"
        ]
    }
}