Skip to main content

CreatedKey

objectrequired
Constant value: api_key
idstringrequired
kindstringrequired

Possible values: [live, test, admin]

namestring | nullnullable
statusstringrequired

Possible values: [active, disabled, deleted]

scopesScope[]required

Possible values: [segment:run, segment:read, usage:read, keys:manage, billing:manage]

hintstring

The key's last four characters, e.g. ...9fQ2.

created_atstring<date-time>required
expires_at(string | null)<date-time>nullable
last_used_at(string | null)<date-time>nullable
limits object
monthly_usdnumber
requests_per_minuteinteger
keystringrequired

The secret. Shown only in this response.

Possible values: Value must match regular expression ^pnk_(live|test|admin)_[0-9A-Za-z]{36}$

notestring
CreatedKey
{
"id": "string",
"kind": "live",
"name": "string",
"status": "active",
"scopes": [
"segment:run"
],
"hint": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"expires_at": "2024-07-29T15:51:28.071Z",
"last_used_at": "2024-07-29T15:51:28.071Z",
"limits": {
"monthly_usd": 0,
"requests_per_minute": 0
},
"key": "string",
"note": "string"
}