Project Aliases API

Tier: 프리미엄, 얼티밋 Offering: 자체 관리, GitLab Dedicated

모든 메소드는 관리자 권한이 필요합니다.

모든 프로젝트 별칭 나열

모든 프로젝트 별칭의 목록을 가져옵니다: 

GET /project_aliases

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 string 예 별칭의 이름. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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 string 예 별칭의 이름. 고유해야 합니다.
project_id integer 또는 string 예 프로젝트의 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>" \
     --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"
}

프로젝트 별칭 삭제

프로젝트 별칭을 제거합니다. 프로젝트 별칭이 있는 경우 204로 응답하며, 해당 별칭이 없는 경우 404로 응답합니다: 

DELETE /project_aliases/:name
속성 타입 필수 여부 설명
name string 예 별칭의 이름. 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"