gitlabhq/doc/api
Felix Gilcher 2ddaf00387 Added documentation for passing the token as header
The documentation was unclear about how to pass the api private token as
header. Updated the doc to include the nessesary information bits and
added an example using the curl command line client.
2013-01-28 14:49:27 +01:00
..
issues.md Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +01:00
merge_requests.md Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +01:00
milestones.md Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +01:00
notes.md Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +01:00
projects.md Remove path parameter from projects API 2012-12-22 20:06:18 +01:00
README.md Added documentation for passing the token as header 2013-01-28 14:49:27 +01:00
repositories.md Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +01: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 Remove all references tp the project code parameter from the API 2012-12-21 18:47:04 +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. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). 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/v3/projects?private_token=QVy1PB7sTxfy4pqfZM1U

Example for a valid API request using curl and authentication via header:

curl --header "PRIVATE-TOKEN: QVy1PB7sTxfy4pqfZM1U" "http://example.com/api/v3/projects"

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