debian-mirror-gitlab/doc/api/pages.md

32 lines
1.1 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
2023-06-20 00:43:36 +05:30
stage: Plan
group: Knowledge
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-11-11 11:23:49 +05:30
# Pages API **(FREE)**
2020-01-01 13:55:28 +05:30
2020-04-22 19:07:51 +05:30
Endpoints for managing [GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/).
2020-01-01 13:55:28 +05:30
The GitLab Pages feature must be enabled to use these endpoints. Find out more about [administering](../administration/pages/index.md) and [using](../user/project/pages/index.md) the feature.
2023-05-27 22:25:52 +05:30
## Unpublish Pages
2020-01-01 13:55:28 +05:30
2023-05-27 22:25:52 +05:30
Prerequisite:
- You must have administrator access to the instance.
Remove Pages.
2020-01-01 13:55:28 +05:30
2020-05-24 23:13:21 +05:30
```plaintext
2020-01-01 13:55:28 +05:30
DELETE /projects/:id/pages
```
| Attribute | Type | Required | Description |
| --------- | -------------- | -------- | ---------------------------------------- |
2023-04-23 21:23:45 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user |
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request 'DELETE' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/2/pages"
2020-01-01 13:55:28 +05:30
```