POST
/
keys

The key returned would be show unencrypted the first time you generate it, ensure you show it to your user because it won’t be show to you again.

Headers

x-api-key
string

your workspace API key

Body

application/json
api_id
string
required

API ID from your dashboard

name
string
required

A name you would like to assign to the key

prefix
string

A string that would be prefixed to you key (prefix_keyxxxx)

length
integer
default: 16

how long you want you key to be, minimum of 16

Required range: 16 < x < 255
meta
object

a object for you to pass values that would be meaningful to you

expires_at
integer

a unix time stamp in the future of when you want the key to expire

verification_limit
integer

maximum verification allowed for this key

Response

200 - application/json
api_id
string

The ID of the API the key belongs to

name
string

The name assigned to the key

prefix
string

The prefix assigned to the key

length
integer
default: 16

The length assigned to the key

Required range: 16 < x < 255
meta
object

extra details you passed via the meta attribute

expires_at
integer

Unix timestamp of when the key expires, returns null when not set

verification_limit
integer

maximum verification allowed for this key, returns null when not set