gitlabhq/doc/api
Sebastian Ziebell 7499f65014 API: extracted helper method to validate required parameters, code clean up
Added a helper method to check if required parameters are given in an API call. Can be used
to return a `400 Bad Request` return code if a required attribute is missing.
Code clean up and fixed tests.
2013-02-27 17:50:30 +01:00
..
groups.md API: groups documentation updated, functions return different status codes 2013-02-27 12:34:45 +01:00
issues.md API: merge request documentation updated, added return codes to functions 2013-02-27 15:07:42 +01:00
merge_requests.md API: merge request documentation updated, added return codes to functions 2013-02-27 15:07:42 +01:00
milestones.md API documentation update for milestones 2013-02-20 22:51:59 +01:00
notes.md API: fixes return codes for notes, documentation updated 2013-02-20 22:17:05 +01:00
projects.md API: extracted helper method to validate required parameters, code clean up 2013-02-27 17:50:30 +01:00
README.md Merge branch 'feature/api-documentation-fixes' of github.com:Xylakant/gitlabhq into fixes/api 2013-02-27 16:49:45 +01:00
repositories.md API repository documentation updated, includes infos to return codes 2013-02-27 11:24:12 +01:00
session.md API: session documentation updated and test added 2013-02-27 12:58:06 +01:00
snippets.md API documentation updated for project snippets. 2013-02-21 21:13:46 +01:00
users.md API: fixes return codes, documentation updated with status codes, tests added 2013-02-20 12:23:56 +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 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