From 2ddaf0038710d057e96f8211036399aa65d3ddb4 Mon Sep 17 00:00:00 2001 From: Felix Gilcher Date: Mon, 28 Jan 2013 14:49:27 +0100 Subject: 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. --- doc/api/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'doc/api/README.md') diff --git a/doc/api/README.md b/doc/api/README.md index 477429c9fa0..881d4ab638f 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,6 +1,6 @@ # 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. +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: @@ -18,6 +18,13 @@ 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 -- cgit v1.2.1