#######################
Pages and Pages domains
#######################

Project pages
=============

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectPages`
  + :class:`gitlab.v4.objects.ProjectPagesManager`
  + :attr:`gitlab.v4.objects.Project.pages`

* GitLab API: https://docs.gitlab.com/api/pages

Examples
--------

Get Pages settings for a project::

    pages = project.pages.get()

Update Pages settings for a project::

    project.pages.update(new_data={'pages_https_only': True})

Delete (unpublish) Pages for a project (admin only)::

    project.pages.delete()

Pages domains (admin only)
==========================

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.PagesDomain`
  + :class:`gitlab.v4.objects.PagesDomainManager`
  + :attr:`gitlab.Gitlab.pagesdomains`

* GitLab API: https://docs.gitlab.com/api/pages_domains#list-all-pages-domains

Examples
--------

List all the existing domains (admin only)::

    domains = gl.pagesdomains.list(get_all=True)

Project Pages domains
=====================

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectPagesDomain`
  + :class:`gitlab.v4.objects.ProjectPagesDomainManager`
  + :attr:`gitlab.v4.objects.Project.pagesdomains`

* GitLab API: https://docs.gitlab.com/api/pages_domains#list-pages-domains

Examples
--------

List domains for a project::

    domains = project.pagesdomains.list(get_all=True)

Get a single domain::

    domain = project.pagesdomains.get('d1.example.com')

Create a new domain::

    domain = project.pagesdomains.create({'domain': 'd2.example.com})

Update an existing domain::

    domain.certificate = open('d2.crt').read()
    domain.key = open('d2.key').read()
    domain.save()

Delete an existing domain::

    domain.delete
    # or
    project.pagesdomains.delete('d2.example.com')