페이지 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab Pages를 관리하기 위한 엔드포인트입니다.

GitLab Pages 기능은 이러한 엔드포인트를 사용하려면 활성화되어야 합니다. 관리 및 사용에 대해 자세히 알아보세요.

페이지 취소

필수 구성 요소:

  • 인스턴스에 대한 관리자 액세스가 있어야 합니다.

페이지 제거. 

DELETE /projects/:id/pages
속성 유형 필요 여부 설명
id 정수/문자열 yes 프로젝트의 ID 또는 URL 인코딩된 경로 
curl --request 'DELETE' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/2/pages"

프로젝트의 페이지 설정 가져오기

필수 구성 요소:

  • 프로젝트의 유지관리자 역할을 적어도 가지고 있어야 합니다.

프로젝트의 페이지 설정 목록. 

GET /projects/:id/pages

지원되는 속성:

속성 유형 필요 여부 설명
id 정수/문자열 Yes 프로젝트의 ID 또는 URL 인코딩된 경로

성공하면 200과 다음 응답 속성을 반환합니다.

속성 유형 설명
url 문자열 이 프로젝트의 페이지에 액세스할 수 있는 URL.
is_unique_domain_enabled 부울 고유 도메인이 활성화되어 있는지 여부.
force_https 부울 프로젝트가 HTTPS를 강제로 사용하도록 설정되어 있는 경우 true.
deployments[] 배열 현재 활성화된 배포 목록.
deployments[] 속성 유형 설명
created_at 날짜 배포가 생성된 날짜.
url 문자열 해당 배포를 위한 URL.
path_prefix 문자열 병렬 배포를 사용할 때 해당 배포의 경로 접두어.
root_directory 문자열 루트 디렉터리.

요청 예시: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/2/pages"

응답 예시: 

{
  "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010",
  "is_unique_domain_enabled": true,
  "force_https": false,
  "deployments": [
    {
      "created_at": "2024-01-05T18:58:14.916Z",
      "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010/",
      "path_prefix": "",
      "root_directory": null
    },
    {
      "created_at": "2024-01-05T18:58:46.042Z",
      "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010/mr3",
      "path_prefix": "mr3",
      "root_directory": null
    }
  ]
}

프로젝트의 페이지 설정 업데이트

필수 구성 요소:

  • 인스턴스에 대한 관리자 액세스가 있어야 합니다.

프로젝트의 페이지 설정 업데이트. 

PATCH /projects/:id/pages

지원되는 속성:

속성 유형 필요 여부 설명
id 정수/문자열 Yes 프로젝트의 ID 또는 URL 인코딩된 경로
pages_unique_domain_enabled 부울 No 고유 도메인을 사용할지 여부
pages_https_only 부울 No HTTPs를 강제로 사용할지 여부

성공하면 200과 다음 응답 속성을 반환합니다.

속성 유형 설명
url 문자열 이 프로젝트의 페이지에 액세스할 수 있는 URL.
is_unique_domain_enabled 부울 고유 도메인이 활성화되어 있는지 여부.
force_https 부울 프로젝트가 HTTPS를 강제로 사용하도록 설정되어 있는 경우 true.
deployments[] 배열 현재 활성화된 배포 목록.
deployments[] 속성 유형 설명
created_at 날짜 배포가 생성된 날짜.
url 문자열 해당 배포를 위한 URL.
path_prefix 문자열 병렬 배포를 사용할 때 해당 배포의 경로 접두어.
root_directory 문자열 루트 디렉터리.

요청 예시: 

curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" --url "https://gitlab.example.com/api/v4/projects/:id/pages" \
--form 'pages_unique_domain_enabled=true' --form 'pages_https_only=true'

응답 예시: 

{
  "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010",
  "is_unique_domain_enabled": true,
  "force_https": false,
  "deployments": [
    {
      "created_at": "2024-01-05T18:58:14.916Z",
      "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010/",
      "path_prefix": "",
      "root_directory": null
    },
    {
      "created_at": "2024-01-05T18:58:46.042Z",
      "url": "http://html-root-4160ce5f0e9a6c90ccb02755b7fc80f5a2a09ffbb1976cf80b653.pages.gdk.test:3010/mr3",
      "path_prefix": "mr3",
      "root_directory": null
    }
  ]
}