Skip to main content
POST
/
v1
/
keys.updateRemaining
Update key credits
curl --request POST \
  --url https://api.unkey.dev/v1/keys.updateRemaining \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyId": "key_123",
  "op": "increment",
  "value": 1
}
'
{
  "remaining": 100
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
keyId
string
required

The id of the key you want to modify

Example:

"key_123"

​
op
enum<string>
required

The operation you want to perform on the remaining count

Available options:
increment,
decrement,
set
​
value
integer | null
required

The value you want to set, add or subtract the remaining count by

Example:

1

Response

The configuration for an api

​
remaining
integer | null
required

The number of remaining requests for this key after updating it. null means unlimited.

Example:

100