Keys

  1. List Keys
  2. Get Key
  3. Create Key
  4. Delete Key

/keys

List Keys

URL:  /keys 

Method: GET

Protocol: HTTP, HTTPS

Returns:

  • 200 (OK) + a collection of keys

Example:

$ curl -X GET http://api.giscloud.com/1/keys

<keys>
  <key>
    <id>1</id>
    <uid>18</uid>
    <key>11111111111111111111111111111111</key>
    <key_desc>Description here</key_desc>
   </key>
</keys>

Get Key

URL:  /keys/{id} 

Method: GET

Protocol: HTTP, HTTPS

Parameters: id – key to be retrieved

Example:

$ curl -X GET http://api.giscloud.com/1/keys/1

<key>
  <id>1</id>
  <uid>18</uid>
  <key>11111111111111111111111111111111</key>
  <key_desc>Description here</key_desc>
</key>

Create Key

URL:  /keys 

Method: POST

Protocol: HTTPS

Returns:

  • 201 + a URL to the newly created resource in the Location header of the response

Example:

$ curl -X POST https://api.giscloud.com/1/keys

Delete Key

URL:  /keys/{id} 

Method: DELETE

Protocol: HTTPS

Parameters:

  • id – key to be deleted

Returns one of:

  • 204 if successful
  • 404 if the resource wasn’t found