latestOpenAPI 3.0.12026-08-212698149.9 KB

2b049ae2733f

keys

Creates a key

post/apps/{app_id}/keys

Path parameters

app_idstring required

Request body

namestring required

revocableTokensboolean nullable

capabilityobject required

Example request

{
  "name": "string",
  "revocableTokens": true,
  "capability": {
    "channel1": [
      "publish",
      "subscribe"
    ],
    "channel2": [
      "history"
    ]
  }
}

Response

Key created

appIdstring

idstring

namestring nullable

statusinteger

keystring

revocableTokensboolean nullable

capabilityobject

createdinteger

modifiedinteger

Example response

{
  "appId": "string",
  "id": "string",
  "name": "string",
  "key": "string",
  "created": 0,
  "modified": 0,
  "revocableTokens": true,
  "capability": {
    "channel1": [
      "publish",
      "subscribe"
    ],
    "channel2": [
      "history"
    ]
  }
}