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

プラン: Premium、Ultimate
提供形態: GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、プロジェクトエイリアスを管理します。プロジェクトにエイリアスを作成すると、ユーザーはエイリアスを使用してリポジトリをクローンできます。これは、リポジトリの移行時に役立ちます。

すべてのメソッドには管理者認可が必要です。

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

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

GET /project_aliases

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`id`	整数	プロジェクトエイリアスのID。
`name`	文字列	エイリアスの名前。
`project_id`	整数	関連付けられたプロジェクトのID。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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`	文字列	はい	エイリアスの名前。

成功した場合、200 OKと次のレスポンス属性を返します:

属性	型	説明
`id`	整数	プロジェクトエイリアスのID。
`name`	文字列	エイリアスの名前。
`project_id`	整数	関連付けられたプロジェクトのID。

リクエスト例:

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

レスポンス例:

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

プロジェクトエイリアスを作成する

プロジェクトに新しいエイリアスを追加します:

POST /project_aliases

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`name`	文字列	はい	エイリアスの名前。一意である必要があります。
`project_id`	整数または文字列	はい	プロジェクトのIDまたはパス。

成功した場合、201 Createdと次のレスポンス属性を返します:

属性	型	説明
`id`	整数	プロジェクトエイリアスのID。
`name`	文字列	エイリアスの名前。
`project_id`	整数	関連付けられたプロジェクトのID。

リクエスト例:

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

プロジェクトパスを使用することもできます:

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

レスポンス例:

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

プロジェクトエイリアスを削除する

プロジェクトエイリアスを削除します:

DELETE /project_aliases/:name

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`name`	文字列	はい	エイリアスの名前。

成功した場合、204 No Contentを返します。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"