Pages API

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

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

GitLab Pages 기능을 사용하려면 활성화해야 합니다. 기능 관리에 대해 더 알아보려면 관리 및 사용을 참조하세요.

페이지 취소 게시

전제 조건:

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

페이지를 제거합니다. 

DELETE /projects/:id/pages
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 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 정수/문자열 예 인증된 사용자가 소유한 프로젝트의 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
    }
  ]
}