페이지 API
Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-Managed, GitLab Dedicated
GitLab Pages를 관리하기 위한 엔드포인트입니다.
이 엔드포인트를 사용하려면 GitLab Pages 기능을 활성화해야 합니다. 관리 및 사용하는 방법에 대해 자세히 알아보세요.
페이지 삭제
전제 조건:
- 사용자는 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.
페이지를 삭제합니다.
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"
프로젝트의 페이지 설정 가져오기
- GitLab 16.8에서 도입되었습니다.
전제 조건:
- 프로젝트에 대한 유지자 역할을 적어도 가져야 합니다.
프로젝트의 페이지 설정을 나열합니다.
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[] attribute
| 유형 | 설명 |
---|---|---|
created_at
| date | 배포가 생성된 날짜입니다. |
url
| string | 이 배포를 위한 URL입니다. |
path_prefix
| string | 여러 배포 사용 시이 배포의 경로 접두어입니다. |
root_directory
| 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
}
]
}
프로젝트의 페이지 설정 업데이트
- GitLab 17.0에서 도입되었습니다.
전제 조건:
- 사용자는 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.
프로젝트의 페이지 설정을 업데이트합니다.
PATCH /projects/:id/pages
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| integer/string | Yes | 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로 |
pages_unique_domain_enabled
| boolean | No | 고유 도메인을 사용할지 여부 |
pages_https_only
| boolean | No | HTTPs를 강제로 사용할지 여부 |
성공적으로 완료되면 200
및 다음 응답 속성을 반환합니다.
속성 | 유형 | 설명 |
---|---|---|
url
| string | 이 프로젝트의 페이지에 액세스할 수 있는 URL입니다. |
is_unique_domain_enabled
| boolean | 고유 도메인이 활성화되었는지 여부입니다. |
force_https
| boolean | 프로젝트가 HTTPS를 강제로 설정하는 경우 true 입니다.
|
deployments[]
| array | 현재 활성 배포 디렉터리입니다. |
deployments[] attribute
| 유형 | 설명 |
---|---|---|
created_at
| date | 배포가 생성된 날짜입니다. |
url
| string | 이 배포를 위한 URL입니다. |
path_prefix
| string | 여러 배포 사용 시이 배포의 경로 접두어입니다. |
root_directory
| string | 루트 디렉터리입니다. |
예제 요청:
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
}
]
}