Skip to content
Snippets Groups Projects
Commit 2ddaf003 authored by Felix Gilcher's avatar Felix Gilcher
Browse files

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.
parent bd948549
No related branches found
No related tags found
2 merge requests!2835Fix API return codes,!2808WIP - Various improvements to the API documentation
# 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:
 
Loading
Loading
@@ -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
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment