gitlabhq/doc/api
2012-09-03 18:00:24 +03:00
..
issues.md API: expose issues project id 2012-07-25 04:22:21 -07:00
milestones.md Add milestone API docs to doc/README and views/help/api 2012-08-29 08:45:00 -04:00
projects.md Create project via API: fixes added 2012-09-03 18:00:24 +03:00
README.md add pagination to API 2012-09-03 04:46:29 -07:00
snippets.md Move snippets api doc to separate file 2012-08-25 19:21:11 +03:00
users.md add docs for existing API 2012-07-05 06:57:45 -07:00

Gitlab API

All API requests require authentication. You need to pass private_token parameter to authenticate.

To get or reset your token visit your profile.

If no or invalid private_token provided error message will be returned with status code 401:

{
  "message": "401 Unauthorized"
}

API requests should be prefixed with api and the API version. API version is equal to Gitlab major version number and defined in lib/api.rb.

Example of valid API request:

GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U

The API uses JSON to serialize data. You don't need to specify .json at the end of API URL.

Pagination

When listing resources you can pass the following parameters:

  • page (default: 1) - page number
  • per_page (default: 20, max: 100) - how many items to list per page

Contents