Default branch settings

Prev Next

Available in Classic and VPC

Set the default branch.

Request

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

Method URI
POST /api/v1/repository/{repositoryName}/branch/default

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 body

You can include the following data in the body of your request:

Field Type Required Description
default String Required Branch name to set as the default branch

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Boolean - API call success status
  • Upon success, display true.
  • No field is displayed upon failure.

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": true
}