Pages API

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

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

GitLab Pages 기능을 사용하려면 활성화해아 합니다. 기능에 대해 자세히 알아보려면 관리 및 사용을 참조하십시오.

페이지 Unpublish

필수 사항:

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

페이지 제거. 

DELETE /projects/:id/pages
속성 유형 필요 여부 설명
id integer/string 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 integer/string Yes 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로

성공하면 200 및 다음의 응답 속성을 반환합니다:

속성 유형 설명
url string 이 프로젝트 페이지에 액세스하는 URL
is_unique_domain_enabled boolean 고유 도메인이 활성화되어 있는지 여부
force_https boolean 프로젝트가 HTTPS를 강제로 설정한 경우 true입니다
deployments[] array 현재 활성 배포 디렉터리
deployments[] 속성 유형 설명
created_at date 배치가 생성된 날짜
url string 이 배포에 대한 URL
path_prefix string 여러 배치를 만들 때 이 배포의 경로 접두사
root_director string 루트 디렉터리

예시 요청: 

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
    }
  ]
}