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

すべてのメソッドには管理者の作成権限が必要です。

すべてのプロジェクトエイリアスのリスト

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

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 Createdで応答します。すでにエイリアスが存在する場合など、検証エラーが発生した場合は、400 Bad Requestを返します：

POST /project_aliases
属性種類必須説明
name文字列です。 {チェックサークル｝はいエイリアスの名前。一意でなければなりません。
project_id整数または文字列。 {チェックサークル｝はいプロジェクトのIDまたはパス。
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"