History

Felix Gilcher 566de5ab06 update api documentation for delete team member correctly describes the new behavior		2013-02-01 14:20:51 +00: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	update api documentation for delete team member	2013-02-01 14:20:51 +00:00
README.md	remove incorrect information about the api version	2013-01-28 10:59:39 +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

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

README.md

GitLab API

Pagination

Contents