Change an API key

PATCH
/v1/api-keys/{id}

Changes what this key may do, or its spending ceilings. Only the fields sent change; send null to clear a limit or to give the key back full, unlevelled access.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Path Parameters

id*string

Request Body

application/json
  1. body
level?|null
perOrderLimit?|

Largest single order this key may place, in cents. null clears it

dailyLimit?|

Most this key may spend in one UTC day, in cents. null clears it

Response Body

Success

application/json
  1. response

Success

id*string
name*string
prefix*string

The first characters of the key, to recognise it by

level?string

What this key may do: 'read' reads only, 'manage' also changes what you already own, 'buy' also spends money. Absent means no ceiling at all, the same as every key made before this field existed

Value in"read""manage""buy"
perOrderLimit?integer

Largest single order this key may place, in cents

Range0 <= value <= 100000000
dailyLimit?integer

Most this key may spend in one UTC day, in cents

Range0 <= value <= 100000000
lastUsedAt*|
Formatdate-time
createdAt*string
Formatdate-time
curl -X PATCH "https://example.com/v1/api-keys/key_01K6XJ4Q8ZT3M9R5V2B7WDHNCA" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "key_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "name": "production",  "prefix": "rhq_test_k3J9xQ",  "level": "read",  "perOrderLimit": 500000,  "dailyLimit": 500000,  "lastUsedAt": null,  "createdAt": "2026-10-07T11:04:31.000Z"}