GitLab Documentation

Repository files

CRUD for repository files

Create, read, update and delete repository files using this API

Get file from repository

Allows you to receive information about file in repository like name, size, content. Note that file content is Base64 encoded. This endpoint can be accessed without authentication if the repository is publicly accessible.

GET /projects/:id/repository/files
curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/models/key.rb&ref=master'

Example response:

{
  "file_name": "key.rb",
  "file_path": "app/models/key.rb",
  "size": 1476,
  "encoding": "base64",
  "content": "IyA9PSBTY2hlbWEgSW5mb3...",
  "ref": "master",
  "blob_id": "79f7bbd25901e8334750839545a9bd021f0e4c83",
  "commit_id": "d5a3ff139356ce33e37e73add446f16869741b50",
  "last_commit_id": "570e7b2abdd848b95f2f578043fc23bd6f6fd24d"
}

Parameters:

Create new file in repository

POST /projects/:id/repository/files
curl --request POST --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20content&commit_message=create%20a%20new%20file'

Example response:

{
  "file_path": "app/project.rb",
  "branch_name": "master"
}

Parameters:

Update existing file in repository

PUT /projects/:id/repository/files
curl --request PUT --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&content=some%20other%20content&commit_message=update%20file'

Example response:

{
  "file_path": "app/project.rb",
  "branch_name": "master"
}

Parameters:

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

Currently gitlab-shell has a boolean return code, preventing GitLab from specifying the error.

Delete existing file in repository

DELETE /projects/:id/repository/files
curl --request DELETE --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v3/projects/13083/repository/files?file_path=app/project.rb&branch_name=master&author_email=author%40example.com&author_name=Firstname%20Lastname&commit_message=delete%20file'

Example response:

{
  "file_path": "app/project.rb",
  "branch_name": "master"
}

Parameters: