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
your workspace API key
Body
application/json
API ID from your dashboard
Example:
"{api_id}"
A name you would like to assign to the key
Example:
"{api_name}"
A string that would be prefixed to you key (prefix_keyxxxx)
Example:
"prefix"
how long you want you key to be, minimum of 16
Required range:
16 <= x <= 255
a object for you to pass values that would be meaningful to you
Example:
{ "user_id": "123456" }
a unix time stamp in the future of when you want the key to expire
maximum verification allowed for this key
Response
OK
The ID of the API the key belongs to
Example:
"{api_id}"
The name assigned to the key
Example:
"{api_name}"
The prefix assigned to the key
Example:
"prefix"
The length assigned to the key
Required range:
16 <= x <= 255
extra details you passed via the meta attribute
Example:
{ "user_id": "123456" }
Unix timestamp of when the key expires, returns null
when not set
maximum verification allowed for this key, returns null
when not set