API Key API

This API returns JSON containing information about the API keys existing in the system.

Call

(tdm component)/api/keys/(option)

Options

URL	Operation
/api/keys/list	lists all existing API keys
/api/keys/create	creates a new, random API key
/api/keys/create/(keyvalue)	creates a new API key with the specified keyvalue
/api/keys/delete/(keyvalue)	removes the API key with the specified keyvalue

Response

GET /api/keys/list

 {
  "keys": [
    {
      "keyvalue": "(keyvalue)",
    },
    (previous repeated for each key)
  ],
  "status": "(status string, "OK" or "ERROR")",
  "message": "(additional status details)"
 }

GET /api/keys/create (creates a random key - will be a UUID) or GET /api/keys/create/(keyvalue) (creates the given key)

 {  "key": {
    "keyvalue": "(keyvalue)"
  },
  "status": "(status string, "OK" or "ERROR")",
  "message": "(additional status details)"
 }

GET /api/keys/delete/(keyvalue)

 {
  "key": {
    "keyvalue": "(keyvalue)"
  },
  "status": "(status string, "OK" or "ERROR")",
  "message": "(additional status details)"
 }