API Client List

By December 7, 2017Clients

Returns an array of your API clients.

URL

GET https://secure.gaug.es/clients

Request

curl -H "X-Gauges-Token: <token>" https://secure.gaug.es/clients

Response

{
  "clients": [{
    "created_at": "2011-10-27T15:21:57Z",
    "urls": {
      "self": "https://secure.gaug.es/clients/8ee4648f95733342b2f9f9b3ea8b82b3"
    },
    "description": "Campfire",
    "key": "8ee4648f95733342b2f9f9b3ea8b82b3"
  }]
}

Creating an API Client

Creates an API client, which can be used to authenticate against the Gaug.es API.

URL

POST https://secure.gaug.es/clients

Parameters

description optional Short description for the key (i.e.: HipChat, Campfire, etc.)

Request

curl -H "X-Gauges-Token: <token>" \
     -d "description=HipChat" \
     https://secure.gaug.es/clients

Response

{
  "client": {
    "created_at": "2011-10-27T15:51:41Z",
    "urls": {
      "self": "https://secure.gaug.es/clients/a363fcbfab425292a1e420cf68c02f20"
    },
    "description": "HipChat",
    "key": "a363fcbfab425292a1e420cf68c02f20"
  }
}

Delete an API Client

Permanently deletes an API client key.

URL

DELETE https://secure.gaug.es/clients/:id

Request

curl -H "X-Gauges-Token: <token>" \
     -X DELETE \
     https://secure.gaug.es/clients/:id

Response

{
  "client": {
    "created_at": "2011-10-27T15:51:41Z",
    "urls": {
      "self": "https://secure.gaug.es/clients/a363fcbfab425292a1e420cf68c02f20"
    },
    "description": "HipChat",
    "key": "a363fcbfab425292a1e420cf68c02f20"
  }
}

Leave a Reply