deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
gitlabhq/doc/api
History
Sebastian Ziebell 873db06255 API: groups documentation updated, functions return different status codes 
Updates the API documentation of groups with infos to return codes. The function calls
in the groups API have updated documentation and return `400 Bad Request` status code
if a required attribute is missing.
2013-02-27 12:34:45 +01:00
..
groups.md API: groups documentation updated, functions return different status codes 2013-02-27 12:34:45 +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 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 Merge branch 'master' into fixes/api 2013-02-20 14:30:11 +01:00
README.md Add docs/tests for groups api 2013-02-01 14:59:22 +01:00
repositories.md API repository documentation updated, includes infos to return codes 2013-02-27 11:24:12 +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 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

README.md

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 defined in lib/api.rb.

Example of a valid API request:

GET http://example.com/api/v3/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