GitLab GitLab Pages API

openapi: 3.2.0
info:
  title: GitLab REST GitLab Pages API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: GitLab Pages
  description: 'Use this API to administer and

    use GitLab Pages, including managing

    custom domains.


    GitLab Pages must be enabled to use these endpoints.'
  x-displayName: GitLab Pages
  externalDocs:
    url: https://docs.gitlab.com/api/pages_domains/
paths:
  /api/v4/pages/domains:
    get:
      operationId: getApiV4PagesDomains
      summary: List all Pages domains
      description: Lists all Pages domains on the instance. You must have administrator access to the instance.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPagesDomainBasic'
        '400':
          description: Bad Request
      parameters:
      - name: domain
        required: false
        description: Domain of the GitLab Pages site to filter on.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
  /api/v4/projects/{id}/pages/domains:
    get:
      operationId: getApiV4ProjectsIdPagesDomains
      summary: List all Pages domains in a project
      description: Lists all Pages domains in a specified project. You must have permissions to view Pages domains.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesPagesDomain'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdPagesDomains
      summary: Create Pages domain
      description: Creates a Pages domain in a specified project. You must have permissions to create Pages domains.
      tags:
      - GitLab Pages
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPagesDomain'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdPagesDomainsRequest'
  /api/v4/projects/{id}/pages/domains/{domain}:
    get:
      operationId: getApiV4ProjectsIdPagesDomainsDomain
      summary: Retrieve a Pages domain
      description: Retrieves a Pages domain from a specified project. You must have permissions to view Pages domains.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPagesDomain'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: domain
        required: true
        description: Custom domain.
        schema:
          type: string
        in: path
    put:
      operationId: putApiV4ProjectsIdPagesDomainsDomain
      summary: Update Pages domain
      description: Updates a specified Pages domain in a project. You must have permissions to change an existing Pages domain.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: domain
        required: true
        description: Custom domain.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPagesDomainsDomainRequest'
    delete:
      operationId: deleteApiV4ProjectsIdPagesDomainsDomain
      summary: Delete Pages domain
      description: Deletes a specified Pages domain in a project.
      tags:
      - GitLab Pages
      responses:
        '204':
          description: Resource deleted
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: domain
        required: true
        description: Custom domain.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/pages/domains/{domain}/verify:
    put:
      operationId: putApiV4ProjectsIdPagesDomainsDomainVerify
      summary: Verify Pages domain
      description: Verifies a specified Pages domain in a project. You must have permissions to update Pages domains.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesPagesDomain'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: domain
        required: true
        description: Custom domain to verify.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/pages:
    delete:
      operationId: deleteApiV4ProjectsIdPages
      summary: Unpublish Pages
      description: Unpublishes Pages from a specified project. You must have the Maintainer or Owner role for the project.
      tags:
      - GitLab Pages
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
    patch:
      operationId: patchApiV4ProjectsIdPages
      summary: Update Pages settings for a project
      description: Updates Pages settings for a specified project. You must have the Maintainer or Owner role for the project.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4ProjectsIdPagesRequest'
    get:
      operationId: getApiV4ProjectsIdPages
      summary: Retrieve Pages settings for a project
      description: Retrieves Pages settings for a specified project. You must have the Maintainer or Owner role for the project.
      tags:
      - GitLab Pages
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
components:
  schemas:
    postApiV4ProjectsIdPagesDomainsRequest:
      type: object
      properties:
        domain:
          type:
          - string
          - 'null'
          description: Custom domain.
        certificate:
          anyOf:
          - type:
            - string
            - 'null'
            format: binary
          - type:
            - string
            - 'null'
          description: Certificate in PEM format with intermediates following in most specific to least specific order.
        key:
          anyOf:
          - type:
            - string
            - 'null'
            format: binary
          - type:
            - string
            - 'null'
          description: Certificate key in PEM format.
        auto_ssl_enabled:
          type: boolean
          description: If `true`, enables [automatic generation](https://docs.gitlab.com/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration/) of SSL certificates issued by Let's Encrypt for custom domains.
          default: false
        user_provided_certificate:
          type:
          - string
          - 'null'
          description: All or none of `user_provided_certificate`, `user_provided_key` must be provided.
        user_provided_key:
          type:
          - string
          - 'null'
          description: All or none of `user_provided_certificate`, `user_provided_key` must be provided.
      required:
      - domain
    APIEntitiesPagesDomainBasic:
      type: object
      properties:
        domain:
          type: string
        url:
          type: string
        project_id:
          type: string
        verified:
          type: string
        verification_code:
          type: string
        enabled_until:
          type: string
        auto_ssl_enabled:
          type: string
        certificate_expiration:
          $ref: '#/components/schemas/APIEntitiesPagesDomainCertificateExpiration'
    APIEntitiesPagesDomainCertificate:
      type: object
      properties:
        subject:
          type: string
        expired:
          type: string
        certificate:
          type: string
        certificate_text:
          type: string
    APIEntitiesPagesDomain:
      type: object
      properties:
        domain:
          type: string
        url:
          type: string
        verified:
          type: string
        verification_code:
          type: string
        enabled_until:
          type: string
        auto_ssl_enabled:
          type: string
        certificate:
          $ref: '#/components/schemas/APIEntitiesPagesDomainCertificate'
    APIEntitiesPagesDomainCertificateExpiration:
      type: object
      properties:
        expired:
          type: string
        expiration:
          type: string
    patchApiV4ProjectsIdPagesRequest:
      type: object
      properties:
        pages_unique_domain_enabled:
          type:
          - boolean
          - 'null'
          description: If `true`, uses a unique domain.
        pages_https_only:
          type:
          - boolean
          - 'null'
          description: If `true`, forces HTTPS.
        pages_primary_domain:
          type:
          - string
          - 'null'
          description: Primary domain, from the existing assigned domains, to redirect all Pages requests to. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/481334) in GitLab 17.8.
    putApiV4ProjectsIdPagesDomainsDomainRequest:
      type: object
      properties:
        certificate:
          anyOf:
          - type:
            - string
            - 'null'
            format: binary
          - type:
            - string
            - 'null'
          description: Certificate in PEM format with intermediates following in most specific to least specific order.
        key:
          anyOf:
          - type:
            - string
            - 'null'
            format: binary
          - type:
            - string
            - 'null'
          description: Certificate key in PEM format.
        auto_ssl_enabled:
          type:
          - boolean
          - 'null'
          description: If `true`, enables [automatic generation](https://docs.gitlab.com/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration/) of SSL certificates issued by Let's Encrypt for custom domains.
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header