GitLab Files API

openapi: 3.2.0
info:
  title: GitLab REST Files 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: Files
  description: 'Use this API to manage repository files.

    You can also configure rate limits

    for this API.'
  x-displayName: Files
  externalDocs:
    url: https://docs.gitlab.com/api/repository_files/
paths:
  /api/v4/projects/{id}/repository/files/{file_path}/blame:
    head:
      operationId: headApiV4ProjectsIdRepositoryFilesFilePathBlame
      summary: Retrieve file blame metadata
      description: Retrieves blame metadata for lines in a specified file.
      tags:
      - Files
      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:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/headApiV4ProjectsIdRepositoryFilesFilePathBlameRequest'
    get:
      operationId: getApiV4ProjectsIdRepositoryFilesFilePathBlame
      summary: Retrieve file blame history from a repository
      description: Retrieves blame history for a specified file in a repository. Each blame range contains lines and their corresponding commit information. This endpoint is rate-limited for each authenticated user for a given project, and for each IP address for unauthenticated requests. On GitLab Self-Managed and GitLab Dedicated, an administrator can change these limits in the application settings.
      tags:
      - Files
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBlameRange'
        '429':
          description: Too many requests
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      - name: ref
        required: true
        description: Commit SHA or name of a repository branch or tag.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: main
      - name: range
        required: false
        description: Range of lines to return blame information for.
        schema:
          type:
          - object
          - 'null'
        in: query
      - name: range[start]
        required: true
        description: First line number of the range to blame.
        schema:
          type: integer
          minimum: 1
        in: query
      - name: range[end]
        required: true
        description: Last line number of the range to blame.
        schema:
          type: integer
          minimum: 1
        in: query
  /api/v4/projects/{id}/repository/files/{file_path}/raw:
    get:
      operationId: getApiV4ProjectsIdRepositoryFilesFilePathRaw
      summary: Retrieve a raw file from a repository
      description: Retrieves the raw file contents for a specified file in a repository.
      tags:
      - Files
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      - name: ref
        required: false
        description: Commit SHA or name of a repository branch or tag.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: main
      - name: lfs
        required: false
        description: If `true`, returns the Git LFS file contents instead of the pointer. Ignored if the file isn't tracked by Git LFS.
        schema:
          type: boolean
          default: false
        in: query
  /api/v4/projects/{id}/repository/files/{file_path}:
    head:
      operationId: headApiV4ProjectsIdRepositoryFilesFilePath
      summary: Retrieve file metadata
      description: Retrieves metadata for a specified file in a repository.
      tags:
      - Files
      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:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/headApiV4ProjectsIdRepositoryFilesFilePathRequest'
    get:
      operationId: getApiV4ProjectsIdRepositoryFilesFilePath
      summary: Retrieve a file from a repository
      description: Retrieves information about a specified file in a repository. This includes information like the name, size, and the file contents. File content is Base64 encoded.
      tags:
      - Files
      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:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      - name: ref
        required: true
        description: Commit SHA or name of a repository branch or tag.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: main
    post:
      operationId: postApiV4ProjectsIdRepositoryFilesFilePath
      summary: Create a file in a repository
      description: Creates a file in a specified repository. Use the Commits API to create multiple files with a single request.
      tags:
      - Files
      responses:
        '201':
          description: Created
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdRepositoryFilesFilePathRequest'
    put:
      operationId: putApiV4ProjectsIdRepositoryFilesFilePath
      summary: Update a file in a repository
      description: Updates a specified file in a repository. Use the Commits API to update multiple files with a single request.
      tags:
      - Files
      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:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdRepositoryFilesFilePathRequest'
    delete:
      operationId: deleteApiV4ProjectsIdRepositoryFilesFilePath
      summary: Delete a file in a repository
      description: Deletes a specified file in a repository. Use the Commits API to delete multiple files with a single request.
      tags:
      - Files
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: file_path
        required: true
        description: URL-encoded full path to the file, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: lib%2Fclass%2Erb
      - name: branch
        required: true
        description: Name of the branch to commit the deletion into. Combine with `start_branch` to create a new branch.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: main
      - name: commit_message
        required: true
        description: Commit message.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: Initial commit
      - name: start_branch
        required: false
        description: Name of the base branch to create the branch from.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: main
      - name: author_email
        required: false
        description: Email address of the commit author.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: johndoe@example.com
      - name: author_name
        required: false
        description: Name of the commit author.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: John Doe
      - name: last_commit_id
        required: false
        description: Last known file commit ID.
        schema:
          type:
          - string
          - 'null'
        in: query
        example: 2695effb5807a22ff3d138d593fd856244e155e7
components:
  schemas:
    headApiV4ProjectsIdRepositoryFilesFilePathBlameRequest:
      type: object
      properties:
        ref:
          type:
          - string
          - 'null'
          description: Commit SHA or name of a repository branch or tag.
          example: main
      required:
      - ref
    APIEntitiesBlameRangeCommit:
      type: object
      properties:
        id:
          type: string
          example: 2695effb5807a22ff3d138d593fd856244e155e7
        parent_ids:
          type: array
          example:
          - 2a4b78934375d7f53875269ffd4f45fd83a84ebe
          items:
            type: string
        message:
          type: string
          example: Initial commit
        authored_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        author_name:
          type: string
          example: John Smith
        author_email:
          type: string
          example: john@example.com
        committed_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        committer_name:
          type: string
          example: Jack Smith
        committer_email:
          type: string
          example: jack@example.com
    putApiV4ProjectsIdRepositoryFilesFilePathRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The file content to be updated (generated by Multipart middleware)
      required:
      - file
    headApiV4ProjectsIdRepositoryFilesFilePathRequest:
      type: object
      properties:
        ref:
          type:
          - string
          - 'null'
          description: Commit SHA or name of a repository branch or tag.
          example: main
      required:
      - ref
    postApiV4ProjectsIdRepositoryFilesFilePathRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The file content to be created (generated by Multipart middleware)
      required:
      - file
    APIEntitiesBlameRange:
      type: object
      properties:
        commit:
          $ref: '#/components/schemas/APIEntitiesBlameRangeCommit'
        lines:
          type: array
          example:
          - lorem ipsum
          items:
            type: string
  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