Rename an API key.
Changes only the name; the secret, scopes and rate limit stay. An unknown key, a revoked key and a key past its grace period answer 404.
Changes only the name; the secret, scopes and rate limit stay. An unknown key, a revoked key and a key past its grace period answer 404.
bearerAuthAuthorizationBearer <token>A Sluby API key (sluby_...) sent as Authorization: Bearer <key>. Keys carry scopes: upload, read, manage.
id*stringKey id.
application/json- body
name*stringTrimmed; no control characters.
1 <= length <= 100The renamed key.
application/json- response
id*stringuuidname*stringscopes*array<>rate_limit*integerRequests per minute.
is_active*booleancreated_at*stringdate-timeexpires_at*|Set while a rotated-out key is in its grace period.
date-timeprefix*|The first 12 characters of the key (sluby_ and 6 more), to tell keys apart. Null for keys created before prefixes were stored.
last_used_at*|When the key last authenticated a request, to the minute: it is written at most once a minute per key. Null if never used since this was recorded.
date-timecreated_by*|The member who made the key; it acts with their current role and stops while they are removed. Null for a key made from the server (BOOTSTRAP_API_KEY, npm run db:seed-key), made by such a key, or whose maker was deleted: it acts as an admin.
curl -X PATCH 'https://sluby.example.com/api/v1/keys/string' \ -H 'Content-Type: application/json' \ -d '{ "name": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "scopes": [ "upload" ], "rate_limit": 0, "is_active": true, "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "prefix": "string", "last_used_at": "2019-08-24T14:15:22Z", "created_by": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }}