diff options
| author | Travis Miller <travis@travismiller.com> | 2017-11-13 16:05:44 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2017-11-13 16:05:44 +0000 |
| commit | 1162d89ac49553c579ec4d049e74206893ff6302 (patch) | |
| tree | 29db898298f93c35c86788bf36ea782b21dac1a9 /doc | |
| parent | e897d8b7f7755107ab632dc5b392c1dc246eb2c8 (diff) | |
| download | gitlab-ce-1162d89ac49553c579ec4d049e74206893ff6302.tar.gz | |
Add administrative endpoint to list all pages domains
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/pages_domains.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md index 51962595e33..50685f335f7 100644 --- a/doc/api/pages_domains.md +++ b/doc/api/pages_domains.md @@ -4,6 +4,31 @@ Endpoints for connecting custom domain(s) and TLS certificates in [GitLab 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. +## List all pages domains + +Get a list of all pages domains. The user must have admin permissions. + +```http +GET /pages/domains +``` + +```bash +curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/pages/domains +``` + +```json +[ + { + "domain": "ssl.domain.example", + "url": "https://ssl.domain.example", + "certificate": { + "expired": false, + "expiration": "2020-04-12T14:32:00.000Z" + } + } +] +``` + ## List pages domains Get a list of project pages domains. The user must have permissions to view pages domains. |