gitlabhq/doc/api
2012-09-06 16:32:26 +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 Typo fixed 2012-09-06 16:32:26 +03:00
README.md Text changes to API documentation 2012-09-04 09:48:33 +01: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 a private_token parameter to authenticate. You can find or reset your private token in your profile.

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

{
  "message": "401 Unauthorized"
}

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

Example of a 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