Disable an API key
Management key required. Disable a model API key in this Team. Repeated requests are safe.
The api_key_id in a URL is the id returned by Create a model API key (POST /public/v1/api-keys), in ak_... format. Save it to disable or delete the key, set its allowance, or query its usage. The returned key (apikey-...) is for model calls; keep using mgmt-... in the authorization header for management calls.
Management key required. Use a Management API Key (mgmt-...) for your Team, created by a Team Owner. Requests use the Team associated with that key.
No request body. Can manage keys owned by any member, including keys in archived projects. Repeated disabling succeeds. Deleted keys return 404. Follows existing key revocation and gateway cache refresh behavior.
Authorization
ManagementKeyBearer Management key required. Send Authorization: Bearer mgmt-....
In: header
Path Parameters
The id returned by Create a model API key (POST /public/v1/api-keys). Copy the complete ak_... value into this path parameter. Use the mgmt-... management key in the authorization header; the returned key (apikey-...) is for model calls.
^ak_[0-9A-Za-z]{22}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/public/v1/api-keys/ak_0123456789ABCDEFGHIJKL/disable"{ "object": "api_key", "id": "ak_0123456789ABCDEFGHIJKL", "enabled": false, "request_id": "req_example"}Last updated on