![]() Instead of using funtion `error!` the function `not_found!` is used to return 404 error. Adjusted documentation accordingly. |
||
---|---|---|
.. | ||
README.md | ||
groups.md | ||
issues.md | ||
merge_requests.md | ||
milestones.md | ||
notes.md | ||
projects.md | ||
repositories.md | ||
session.md | ||
snippets.md | ||
users.md |
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 numberper_page
(default:20
, max:100
) - number of items to list per page