プロジェクトエイリアスAPI

GitLab Premium12.1で導入されました

どの方法も管理者の承認が必要です。

すべてのプロジェクトのエイリアスをリストします。

すべてのプロジェクトのエイリアスのリストを取得します:

GET /project_aliases
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases"

回答例

[
  {
    "id": 1,
    "project_id": 1,
    "name": "gitlab-foss"
  },
  {
    "id": 2,
    "project_id": 2,
    "name": "gitlab"
  }
]

プロジェクトエイリアスの詳細取得

プロジェクトエイリアスの詳細を取得します:

GET /project_aliases/:name
属性 タイプ 必須 説明
name はい エイリアスの名前
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"

回答例

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

プロジェクトエイリアスの作成

プロジェクトに新しいエイリアスを追加します。 成功した場合は201で応答し、検証エラーが発生した場合は400で応答します(エイリアスが既に存在する場合など):

POST /project_aliases
属性 タイプ 必須 説明
project_id 整数/文字列 はい プロジェクトのIDまたはパス。
name はい エイリアスの名前。 一意でなければなりません。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=1" --form "name=gitlab"

あるいは

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org/gitlab" --form "name=gitlab"

回答例

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

プロジェクトエイリアスの削除

プロジェクトエイリアスが存在する場合は204、存在しない場合は404で応答します:

DELETE /project_aliases/:name
属性 タイプ 必須 説明
name はい エイリアスの名前
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"