デフォルトブランチの設定

Prev Next

Classic/VPC環境で利用できます。

デフォルトブランチを設定します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/repository/{repositoryName}/branch/default

リクエストヘッダ

SourceCommit APIで共通して使用されるヘッダの詳細は、SourceCommitのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
repositoryName String Required リポジトリ名

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
default String Required デフォルトブランチに設定するブランチ名

リクエスト例

リクエストのサンプルコードは次の通りです。

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"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result Boolean - API呼び出しは成功したか
  • 成功した場合、trueと表示
  • 失敗した場合、フィールドは表示されない

レスポンスステータスコード

SourceCommit APIで共通して使用されるレスポンスステータスコードの詳細は、SourceCommitのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": true
}