diff options
Diffstat (limited to 'doc/api/pages.md')
| -rw-r--r-- | doc/api/pages.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/api/pages.md b/doc/api/pages.md new file mode 100644 index 00000000000..0babca61650 --- /dev/null +++ b/doc/api/pages.md @@ -0,0 +1,21 @@ +# Pages API + +Endpoints for managing [GitLab Pages](https://about.gitlab.com/product/pages/). + +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. + +## Unpublish pages + +Remove pages. The user must have admin priviledges. + +```text +DELETE /projects/:id/pages +``` + +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ---------------------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | + +```bash +curl --request 'DELETE' --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/2/pages +``` |