v1

latestOpenAPI 3.0.0Apache 2.02026-07-1410280162.7 KB

apikeys

Update an api key

Update an api key for a specified service group

put/api/groups/{groupId}/apikeys/{clientId}

Path parameters

groupIdstring required

The api key group id

clientIdstring required

the api key id

Request body

authorizedEntitiesstring[] required

The group/service ids (prefixed by group_ or service_ on which the key is authorized

clientIdstring required

The unique id of the Api Key. Usually 16 random alpha numerical characters, but can be anything

clientNamestring required

The name of the api key, for humans ;-)

clientSecretstring required

The secret of the Api Key. Usually 64 random alpha numerical characters, but can be anything

dailyQuotainteger

Authorized number of calls per day

enabledboolean required

Whether or not the key is enabled. If disabled, resources won't be available to calls using this key

metadataobject

Bunch of metadata for the key

monthlyQuotainteger

Authorized number of calls per month

throttlingQuotainteger

Authorized number of calls per second, measured on 10 seconds

Example request

{
  "authorizedEntities": [
    "a string value"
  ],
  "clientId": "a string value",
  "clientName": "a string value",
  "clientSecret": "a string value",
  "dailyQuota": 123,
  "enabled": true,
  "metadata": {
    "key": "value"
  },
  "monthlyQuota": 123,
  "throttlingQuota": 123
}

Response

Successful operation

authorizedEntitiesstring[] required

The group/service ids (prefixed by group_ or service_ on which the key is authorized

clientIdstring required

The unique id of the Api Key. Usually 16 random alpha numerical characters, but can be anything

clientNamestring required

The name of the api key, for humans ;-)

clientSecretstring required

The secret of the Api Key. Usually 64 random alpha numerical characters, but can be anything

dailyQuotainteger

Authorized number of calls per day

enabledboolean required

Whether or not the key is enabled. If disabled, resources won't be available to calls using this key

metadataobject

Bunch of metadata for the key

monthlyQuotainteger

Authorized number of calls per month

throttlingQuotainteger

Authorized number of calls per second, measured on 10 seconds

Example response

{
  "authorizedEntities": [
    "a string value"
  ],
  "clientId": "a string value",
  "clientName": "a string value",
  "clientSecret": "a string value",
  "dailyQuota": 123,
  "enabled": true,
  "metadata": {
    "key": "value"
  },
  "monthlyQuota": 123,
  "throttlingQuota": 123
}