Repository files API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

You can fetch, create, update, and delete files in your repository with this API. You can also configure rate limits for this API.

Available scopes for personal access tokens

Personal access tokens support these scopes:

ScopeDescription
apiAllows read-write access to the repository files.
read_apiAllows read access to the repository files.
read_repositoryAllows read-access to the repository files.

Get file from repository

Allows you to receive information about file in repository like name, size, and content. File content is Base64 encoded. You can access this endpoint without authentication, if the repository is publicly accessible.

Copy to clipboard
GET /projects/:id/repository/files/:file_path
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=main"
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
file_pathstringyesURL encoded full path to new file, such as lib%2Fclass%2Erb.
refstringyesThe name of branch, tag or commit. Use HEAD to automatically use the default branch.

If you don’t know the branch name or want to use the default branch, you can use HEAD as the ref value. For example:

Copy to clipboard
curl --header "PRIVATE-TOKEN: " \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=HEAD"

Response

In the response, blob_id is the blob SHA. See Get a blob from repository in the Repositories API.

Example response:

Copy to clipboard
{
  "file_name": "key.rb",
  "file_path": "app/models/key.rb",
  "size": 1476,
  "encoding": "base64",
  "content": "IyA9PSBTY2hlbWEgSW5mb3...",
  "content_sha256": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
  "ref": "main",
  "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
  "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
  "last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d",
  "execute_filemode": false
}

Get file metadata only

You can also use HEAD to fetch just file metadata.

Copy to clipboard
HEAD /projects/:id/repository/files/:file_path
Copy to clipboard
curl --head --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=main"

Example response:

Copy to clipboard
HTTP/1.1 200 OK
...
X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83
X-Gitlab-Commit-Id: d5a3ff139356ce33e37e73add446f16869741b50
X-Gitlab-Content-Sha256: 4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481
X-Gitlab-Encoding: base64
X-Gitlab-File-Name: key.rb
X-Gitlab-File-Path: app/models/key.rb
X-Gitlab-Last-Commit-Id: 570e7b2abdd848b95f2f578043fc23bd6f6fd24d
X-Gitlab-Ref: main
X-Gitlab-Size: 1476
X-Gitlab-Execute-Filemode: false
...

Get file blame from repository

Retrieve blame information. Each blame range contains lines and their corresponding commit information.

Copy to clipboard
GET /projects/:id/repository/files/:file_path/blame
AttributeTypeRequiredDescription
file_pathstringyesURL-encoded full path to new file, such aslib%2Fclass%2Erb.
idinteger or stringyesThe ID or URL-encoded path of the project.
range[end]integeryesThe last line of the range to blame.
range[start]integeryesThe first line of the range to blame.
refstringyesThe name of branch, tag or commit. Use HEAD to automatically use the default branch.
rangehashnoBlame range.
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=main"

Example response:

Copy to clipboard
[
  {
    "commit": {
      "id": "d42409d56517157c48bf3bd97d3f75974dde19fb",
      "message": "Add feature\n\nalso fix bug\n",
      "parent_ids": [
        "cc6e14f9328fa6d7b5a0d3c30dc2002a3f2a3822"
      ],
      "authored_date": "2015-12-18T08:12:22.000Z",
      "author_name": "John Doe",
      "author_email": "john.doe@example.com",
      "committed_date": "2015-12-18T08:12:22.000Z",
      "committer_name": "John Doe",
      "committer_email": "john.doe@example.com"
    },
    "lines": [
      "require 'fileutils'",
      "require 'open3'",
      ""
    ]
  },
  ...
]

Get file metadata only

Use the HEAD method to return just file metadata, as in Get file from repository:

Copy to clipboard
curl --head --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=main"

Response

Example response:

Copy to clipboard
HTTP/1.1 200 OK
...
X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83
X-Gitlab-Commit-Id: d5a3ff139356ce33e37e73add446f16869741b50
X-Gitlab-Content-Sha256: 4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481
X-Gitlab-Encoding: base64
X-Gitlab-File-Name: file.rb
X-Gitlab-File-Path: path/to/file.rb
X-Gitlab-Last-Commit-Id: 570e7b2abdd848b95f2f578043fc23bd6f6fd24d
X-Gitlab-Ref: main
X-Gitlab-Size: 1476
X-Gitlab-Execute-Filemode: false
...

Request a blame range

To request a blame range, specify range[start] and range[end] parameters with the starting and ending line numbers of the file.

Copy to clipboard
curl --head --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=main&range[start]=1&range[end]=2"

Example response:

Copy to clipboard
[
  {
    "commit": {
      "id": "d42409d56517157c48bf3bd97d3f75974dde19fb",
      "message": "Add feature\n\nalso fix bug\n",
      "parent_ids": [
        "cc6e14f9328fa6d7b5a0d3c30dc2002a3f2a3822"
      ],
      "authored_date": "2015-12-18T08:12:22.000Z",
      "author_name": "John Doe",
      "author_email": "john.doe@example.com",
      "committed_date": "2015-12-18T08:12:22.000Z",
      "committer_name": "John Doe",
      "committer_email": "john.doe@example.com"
    },
    "lines": [
      "require 'fileutils'",
      "require 'open3'"
    ]
  },
  ...
]

Get raw file from repository

Copy to clipboard
GET /projects/:id/repository/files/:file_path/raw
AttributeTypeRequiredDescription
file_pathstringyesURL-encoded full path to new file, such as lib%2Fclass%2Erb.
idinteger or stringyesThe ID or URL-encoded path of the project.
lfsbooleannoDetermines if the response should be Git LFS file contents, rather than the pointer. Ignored if the file is not tracked by Git LFS. Defaults to false. Introduced in GitLab 15.7.
refstringnoThe name of branch, tag or commit. Default is the HEAD of the project.
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=main"

Like Get file from repository, you can use HEAD to get just file metadata.

Create new file in repository

Allows you to create a single file. For creating multiple files with a single request, see the commits API.

Copy to clipboard
POST /projects/:id/repository/files/:file_path
AttributeTypeRequiredDescription
branchstringyesName of the new branch to create. The commit is added to this branch.
commit_messagestringyesThe commit message.
contentstringyesThe file’s content.
file_pathstringyesURL-encoded full path to new file. For example: lib%2Fclass%2Erb.
idinteger or stringyesThe ID or URL-encoded path of the project.
author_emailstringnoThe commit author’s email address.
author_namestringnoThe commit author’s name.
encodingstringnoChange encoding to base64. Default is text.
execute_filemodebooleannoEnables or disables the execute flag on the file. Can be true or false.
start_branchstringnoName of the base branch to create the new branch from.
Copy to clipboard
curl --request POST \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header "Content-Type: application/json" \
  --data '{"branch": "main", "author_email": "author@example.com", "author_name": "Firstname Lastname",
            "content": "some content", "commit_message": "create a new file"}' \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"

Example response:

Copy to clipboard
{
  "file_path": "app/project.rb",
  "branch": "main"
}

Update existing file in repository

Allows you to update a single file. For updating multiple files with a single request, refer to the commits API.

Copy to clipboard
PUT /projects/:id/repository/files/:file_path
AttributeTypeRequiredDescription
branchstringyesName of the new branch to create. The commit is added to this branch.
commit_messagestringyesThe commit message.
contentstringyesThe file’s content.
file_pathstringyesURL-encoded full path to new file. For example: lib%2Fclass%2Erb.
idinteger or stringyesThe ID or URL-encoded path of the project
author_emailstringnoThe commit author’s email address.
author_namestringnoThe commit author’s name.
encodingstringnoChange encoding to base64. Default is text.
execute_filemodebooleannoEnables or disables the execute flag on the file. Can be true or false.
last_commit_idstringnoLast known file commit ID.
start_branchstringnoName of the base branch to create the new branch from.
Copy to clipboard
curl --request PUT \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header "Content-Type: application/json" \
  --data '{"branch": "main", "author_email": "author@example.com", "author_name": "Firstname Lastname",
       "content": "some content", "commit_message": "update file"}' \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"

Example response:

Copy to clipboard
{
  "file_path": "app/project.rb",
  "branch": "main"
}

If the commit fails for any reason we return a 400 Bad Request error with a non-specific error message. Possible causes for a failed commit include:

  • The file_path contained /../ (attempted directory traversal).
  • The commit was empty: new file contents were identical to the current file contents.
  • Someone updated the branch with git push while the file edit was in progress.

GitLab Shell has a Boolean return code, preventing GitLab from specifying the error.

Delete existing file in repository

Deletes a single file. To delete multiple files with a single request, see the commits API.

Copy to clipboard
DELETE /projects/:id/repository/files/:file_path
AttributeTypeRequiredDescription
branchstringyesName of the new branch to create. The commit is added to this branch.
commit_messagestringyesThe commit message.
file_pathstringyesURL-encoded full path to new file. For example: lib%2Fclass%2Erb.
idinteger or stringyesThe ID or URL-encoded path of the project.
author_emailstringnoThe commit author’s email address.
author_namestringnoThe commit author’s name.
last_commit_idstringnoLast known file commit ID.
start_branchstringnoName of the base branch to create the new branch from.
Copy to clipboard
curl --request DELETE \
  --header 'PRIVATE-TOKEN: <your_access_token>' \
  --header "Content-Type: application/json" \
  --data '{"branch": "main", "author_email": "author@example.com", "author_name": "Firstname Lastname",
       "commit_message": "delete file"}' \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"