Skip to main content
GET
Get key

Headers

x-api-key
string

your workspace API key

Path Parameters

id
string
required

your key ID

Response

OK

api_id
string

The ID of the API the key belongs to

Example:

"{api_id}"

name
string

The name assigned to the key

Example:

"{api_name}"

prefix
string

The prefix assigned to the key

Example:

"prefix"

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

Example:
expires_at
integer<int64>

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

verification_limit
integer<int64>

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