Show example with api-key using curl

I always need to look for this, so I think it might be useful here
2015-08-08 21:02:56 +02:00
parent 3f355d26cd
commit 81ef3e2859
1 changed files with 3 additions and 1 deletions
@@ -17,7 +17,9 @@ API Key
 To use the POST methods, or *any* method when authentication is enabled, an API
 key must be set and used. The API key can be generated in the GUI, or set in the
 ``configuration/gui/apikey`` element in the configuration file. To use an API
-key, set the request header ``X-API-Key`` to the API key value.
+key, set the request header ``X-API-Key`` to the API key value. For example,
+``curl -X POST -H "X-API-Key: abc123" http://localhost:8384/rest/...`` can be
+used to invoke authenticated POST methods via ``curl``.

 System Endpoints
 ----------------