gitlabhq/doc/api
2012-12-20 20:52:12 +02:00
..
issues.md Merge pull request #2286 from nuecho/fix-doc-api-issues 2012-12-15 01:29:43 -08:00
merge_requests.md Add username to User and UserBasic entities in API and in examples in doc. 2012-12-12 18:51:20 +01:00
milestones.md Add milestone API docs to doc/README and views/help/api 2012-08-29 08:45:00 -04:00
notes.md Add username to User and UserBasic entities in API and in examples in doc. 2012-12-12 18:51:20 +01:00
projects.md refactoring gfm_autocomplete 2012-12-20 20:52:12 +02:00
README.md update contents of API README 2012-12-01 02:07:57 -08:00
repositories.md separate project repositories API docs 2012-09-21 05:03:50 -07:00
session.md Add username to User and UserBasic entities in API and in examples in doc. 2012-12-12 18:51:20 +01:00
snippets.md Add username to User and UserBasic entities in API and in examples in doc. 2012-12-12 18:51:20 +01:00
users.md Add username to User and UserBasic entities in API and in examples in doc. 2012-12-12 18:51:20 +01:00

GitLab API

All API requests require authentication. You need to pass a private_token parameter by url or header. 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) - number of items to list per page

Contents