프로젝트 별칭 API
Offering: GitLab Self-Managed, GitLab Dedicated
이 API를 사용하여 프로젝트 별칭을 관리합니다. 모든 메서드는 관리자 권한이 필요합니다. 모든 프로젝트 별칭 목록을 조회합니다: 성공하면 200 OK와 다음 응답 속성이 반환됩니다: 프로젝트 별칭의 세부 정보를 조회합니다:
이 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"
