Skip to main content
POST
/
namespace
/
{namespace}
/
bigPeer
/
{big_peer_name}
/
app
/
{app_name}
/
apiKey
Create API Key
curl --request POST \
  --url http://localhost:{port}/namespace/{namespace}/bigPeer/{big_peer_name}/app/{app_name}/apiKey \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresAt": "2100-04-13T12:00:00Z",
  "name": "<string>",
  "permissions": {
    "read": "<unknown>",
    "write": "<unknown>",
    "qlVersion": 0,
    "remoteQuery": false
  },
  "description": "API key used for staging environment."
}
'
"<string>"

Body

application/json
​
expiresAt
string<date-time>
required
Example:

"2100-04-13T12:00:00Z"

​
name
string
required

RFC 1123 DNS labels used for most Kubernetes resource names. Some resource types require their names to follow the DNS label standard as defined in [RFC 1123][rfc1123]. This means the name must: * contain at most 63 characters * contain only lowercase alphanumeric characters or '-' * start with an alphanumeric character * end with an alphanumeric character [rfc1123]: https://tools.ietf.org/html/rfc1123

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
​
permissions
Permission · object
required

Set of permissions granted to a particular API key or device token.

​
description
string | null
Example:

"API key used for staging environment."

Response

Plaintext API key.

The response is of type string.