GitLab Wikis API

openapi: 3.2.0
info:
  title: GitLab REST Wikis 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: Wikis
  description: 'Use this API to manage group wikis.

    An API for project wikis is also available.


    Comments on a wiki page are called `notes`. To interact with them, use the notes API.'
  x-displayName: Wikis
  externalDocs:
    url: https://docs.gitlab.com/api/group_wikis/
paths:
  /api/v4/groups/{id}/wikis:
    get:
      operationId: getApiV4GroupsIdWikis
      summary: List all wiki pages for a group
      description: Lists all wiki pages for a specified group.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesWikiPageBasic'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: with_content
        required: false
        description: If `true`, includes the content of each wiki page.
        schema:
          type: boolean
          default: false
        in: query
      x-gitlab-tier: premium
    post:
      operationId: postApiV4GroupsIdWikis
      summary: Create a wiki page for a group
      description: Creates a wiki page for a specified group. Requests can define the title, slug, and content.
      tags:
      - Wikis
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '400':
          description: Validation error
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdWikisRequest'
      x-gitlab-tier: premium
  /api/v4/groups/{id}/wikis/{slug}:
    get:
      operationId: getApiV4GroupsIdWikisSlug
      summary: Retrieve a wiki page for a group
      description: Retrieves a specified wiki page for a group.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
      - name: version
        required: false
        description: Version SHA of the wiki page.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: render_html
        required: false
        description: If `true`, returns the rendered HTML of the wiki page.
        schema:
          type: boolean
          default: false
        in: query
      x-gitlab-tier: premium
    put:
      operationId: putApiV4GroupsIdWikisSlug
      summary: Update a wiki page for a group
      description: Updates a specified wiki page for a group.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '400':
          description: Validation error
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdWikisSlugRequest'
      x-gitlab-tier: premium
    delete:
      operationId: deleteApiV4GroupsIdWikisSlug
      summary: Delete a wiki page for a group
      description: Deletes a specified wiki page from a group.
      tags:
      - Wikis
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
      x-gitlab-tier: premium
  /api/v4/groups/{id}/wikis/attachments:
    post:
      operationId: postApiV4GroupsIdWikisAttachments
      summary: Upload an attachment to a group wiki
      description: Uploads a file to the `uploads` directory in a specified group wiki.
      tags:
      - Wikis
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiAttachment'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdWikisAttachmentsRequest'
      x-gitlab-tier: premium
  /api/v4/projects/{id}/wikis:
    get:
      operationId: getApiV4ProjectsIdWikis
      summary: List all wiki pages for a project
      description: Lists all wiki pages for a specified project.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesWikiPageBasic'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: with_content
        required: false
        description: If `true`, includes the content of each wiki page.
        schema:
          type: boolean
          default: false
        in: query
    post:
      operationId: postApiV4ProjectsIdWikis
      summary: Create a wiki page for a project
      description: Creates a wiki page for a specified project. Requests can define the title, slug, and content.
      tags:
      - Wikis
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '400':
          description: Validation error
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdWikisRequest'
  /api/v4/projects/{id}/wikis/{slug}:
    get:
      operationId: getApiV4ProjectsIdWikisSlug
      summary: Retrieve a wiki page for a project
      description: Retrieves a specified wiki page for a project.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
      - name: version
        required: false
        description: Version SHA of the wiki page.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: render_html
        required: false
        description: If `true`, returns the rendered HTML of the wiki page.
        schema:
          type: boolean
          default: false
        in: query
    put:
      operationId: putApiV4ProjectsIdWikisSlug
      summary: Update a wiki page for a project
      description: Updates a specified wiki page for a project.
      tags:
      - Wikis
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiPage'
        '400':
          description: Validation error
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdWikisSlugRequest'
    delete:
      operationId: deleteApiV4ProjectsIdWikisSlug
      summary: Delete a wiki page for a project
      description: Deletes a specified wiki page from a project.
      tags:
      - Wikis
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: slug
        required: true
        description: URL-encoded slug of the wiki page, a unique string such as `dir%2Fpage_name`.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/wikis/attachments:
    post:
      operationId: postApiV4ProjectsIdWikisAttachments
      summary: Upload an attachment to a project wiki
      description: Uploads a file to the `uploads` directory in a specified project wiki.
      tags:
      - Wikis
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesWikiAttachment'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group or project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdWikisAttachmentsRequest'
components:
  schemas:
    postApiV4GroupsIdWikisRequest:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
          description: Title of the wiki page.
        front_matter:
          type:
          - object
          - 'null'
          description: YAML front matter of the wiki page.
          properties:
            title:
              type:
              - string
              - 'null'
              description: Title in the front matter of the wiki page.
        content:
          type:
          - string
          - 'null'
          description: Content of the wiki page.
        format:
          type: string
          enum:
          - markdown
          - rdoc
          - asciidoc
          - org
          description: Format of the wiki page.
          default: markdown
      required:
      - title
      - content
    APIEntitiesWikiPage:
      type: object
      properties:
        format:
          type: string
          example: markdown
        slug:
          type: string
          example: deploy
        title:
          type: string
          example: deploy
        wiki_page_meta_id:
          type: integer
          format: int64
          example: 123
        content:
          type: string
          example: Here is an instruction how to deploy this project.
        encoding:
          type: string
          example: UTF-8
        front_matter:
          type: object
          example:
            title: deploy
    postApiV4ProjectsIdWikisAttachmentsRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The attachment file to be uploaded
        branch:
          type:
          - string
          - 'null'
          description: The name of the branch
      required:
      - file
    postApiV4ProjectsIdWikisRequest:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
          description: Title of the wiki page.
        front_matter:
          type:
          - object
          - 'null'
          description: YAML front matter of the wiki page.
          properties:
            title:
              type:
              - string
              - 'null'
              description: Title in the front matter of the wiki page.
        content:
          type:
          - string
          - 'null'
          description: Content of the wiki page.
        format:
          type: string
          enum:
          - markdown
          - rdoc
          - asciidoc
          - org
          description: Format of the wiki page.
          default: markdown
      required:
      - title
      - content
    APIEntitiesWikiAttachment:
      type: object
      properties:
        file_name:
          type: string
          example: dk.png
        file_path:
          type: string
          example: uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png
        branch:
          type: string
          example: main
        link:
          type: object
          properties:
            url:
              type: string
              example: uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png
            markdown:
              type: string
              example: '![dk](uploads/6a061c4cf9f1c28cb22c384b4b8d4e3c/dk.png)'
    putApiV4ProjectsIdWikisSlugRequest:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
          description: Title of the wiki page. At least one of `content`, `title`, `format` must be provided.
        front_matter:
          type:
          - object
          - 'null'
          description: YAML front matter of the wiki page.
          properties:
            title:
              type:
              - string
              - 'null'
              description: Title in the front matter of the wiki page.
        content:
          type:
          - string
          - 'null'
          description: Content of the wiki page. At least one of `content`, `title`, `format` must be provided.
        format:
          type: string
          enum:
          - markdown
          - rdoc
          - asciidoc
          - org
          description: Format of the wiki page. At least one of `content`, `title`, `format` must be provided.
          default: markdown
    postApiV4GroupsIdWikisAttachmentsRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The attachment file to be uploaded
        branch:
          type:
          - string
          - 'null'
          description: The name of the branch
      required:
      - file
    putApiV4GroupsIdWikisSlugRequest:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
          description: Title of the wiki page. At least one of `content`, `title`, `format` must be provided.
        front_matter:
          type:
          - object
          - 'null'
          description: YAML front matter of the wiki page.
          properties:
            title:
              type:
              - string
              - 'null'
              description: Title in the front matter of the wiki page.
        content:
          type:
          - string
          - 'null'
          description: Content of the wiki page. At least one of `content`, `title`, `format` must be provided.
        format:
          type: string
          enum:
          - markdown
          - rdoc
          - asciidoc
          - org
          description: Format of the wiki page. At least one of `content`, `title`, `format` must be provided.
          default: markdown
    APIEntitiesWikiPageBasic:
      type: object
      properties:
        format:
          type: string
          example: markdown
        slug:
          type: string
          example: deploy
        title:
          type: string
          example: deploy
        wiki_page_meta_id:
          type: integer
          format: int64
          example: 123
  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