GitLab Templates API

openapi: 3.2.0
info:
  title: GitLab REST Templates 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: Templates
  description: 'Use this API to retrieve the file templates available to an entire instance:


    - Dockerfile templates

    - `.gitignore` templates

    - CI/CD configuration templates

    - Open source license templates


    Custom CI/CD templates are not available from these endpoints. For templates specific to a project,

    use the project templates API.


    Users with the Guest role can''t access these templates. For more information, see

    project and group visibility.'
  x-displayName: Templates
  externalDocs:
    url: https://docs.gitlab.com/api/templates/dockerfiles/
paths:
  /api/v4/templates/licenses:
    get:
      operationId: getApiV4TemplatesLicenses
      summary: List all license templates
      description: Lists all available license templates.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesLicense'
        '400':
          description: Bad Request
      parameters:
      - name: popular
        required: false
        description: If `true`, returns only popular licenses. If `false`, returns only licenses that aren't popular.
        schema:
          type:
          - boolean
          - '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/templates/licenses/{name}:
    get:
      operationId: getApiV4TemplatesLicensesName
      summary: Retrieve a license template
      description: Retrieves a specified license template. You can pass parameters to replace the license placeholder.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesLicense'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Name of the license template.
        schema:
          type: string
        in: path
      - name: project
        required: false
        description: Name of the copyrighted project.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: fullname
        required: false
        description: Full name of the copyright holder.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/templates/gitignores:
    get:
      operationId: getApiV4TemplatesGitignores
      summary: List all .gitignore templates
      description: Lists all .gitignore templates.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplatesList'
        '400':
          description: Bad Request
      parameters:
      - 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/templates/gitignores/{name}:
    get:
      operationId: getApiV4TemplatesGitignoresName
      summary: Retrieve a .gitignore template
      description: Retrieves a specified .gitignore template.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplate'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: The name of the .gitignore template
        schema:
          type: string
        in: path
  /api/v4/templates/gitlab_ci_ymls:
    get:
      operationId: getApiV4TemplatesGitlabCiYmls
      summary: List all GitLab CI/CD YAML templates
      description: Lists all GitLab CI/CD YAML templates.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplatesList'
        '400':
          description: Bad Request
      parameters:
      - 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/templates/gitlab_ci_ymls/{name}:
    get:
      operationId: getApiV4TemplatesGitlabCiYmlsName
      summary: Retrieve a GitLab CI/CD YAML template
      description: Retrieves a specified GitLab CI/CD YAML template.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplate'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: The name of the GitLab CI/CD YAML template
        schema:
          type: string
        in: path
  /api/v4/templates/dockerfiles:
    get:
      operationId: getApiV4TemplatesDockerfiles
      summary: List all Dockerfile templates
      description: Lists all Dockerfile templates.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplatesList'
        '400':
          description: Bad Request
      parameters:
      - 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/templates/dockerfiles/{name}:
    get:
      operationId: getApiV4TemplatesDockerfilesName
      summary: Retrieve a Dockerfile template
      description: Retrieves a specified Dockerfile template.
      tags:
      - Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTemplate'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: The name of the Dockerfile template
        schema:
          type: string
        in: path
components:
  schemas:
    APIEntitiesTemplate:
      type: object
      properties:
        name:
          type: string
          example: Ruby
        content:
          type: string
          example: '# Ruby gitignore template'
    APIEntitiesLicense:
      type: object
      properties:
        key:
          type: string
          example: gpl-3.0
        name:
          type: string
          example: GNU General Public License v3.0
        nickname:
          type: string
          example: GNU GPLv3
        html_url:
          type: string
          example: http://choosealicense.com/licenses/gpl-3.0
        source_url:
          type: string
        popular:
          type: boolean
        description:
          type: string
          example: A simple license
        conditions:
          type: array
          example:
          - include-copyright
          items:
            type: string
        permissions:
          type: array
          example:
          - commercial-use
          items:
            type: string
        limitations:
          type: array
          example:
          - liability
          items:
            type: string
        content:
          type: string
          example: GNU GENERAL PUBLIC LICENSE
    APIEntitiesTemplatesList:
      type: object
      properties:
        key:
          type: string
          example: mit
        name:
          type: string
          example: MIT License
  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