SourceCommitブランチリストの照会

Prev Next

VPC環境で利用できます。

使用可能な SourceCommitリポジトリのブランチリストを照会します。

リクエスト

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

メソッド URI
GET /api/v1/sourcecommit/repository/{repositoryName}/branch

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.branchList Array - ブランチ名リスト

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

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

レスポンス例

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

{
    "result": {
        "branchList": [
            "app",
            "master"
        ]
    }
}