Skip to main content
GET
/
keys
/
{id}
Get key
curl --request GET \
  --url https://api.datkey.dev/keys/{id}
{
  "key": {
    "id": "<key_id>",
    "name": "<key_name>",
    "key": "flox_sk_05ad2bf*******",
    "prefix": "flox_sk",
    "length": 16,
    "verifications": 0,
    "verification_limit": null,
    "expires_at": 1733237153,
    "meta": null,
    "created_at": "2023-12-05T11:31:23.000000Z",
    "updated_at": "2023-12-05T11:31:23.000000Z"
  }
}

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:
{ "user_id": "123456" }
​
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