latestOpenAPI 3.1.02026-08-202391306.4 MB

720c63a313eb

API key

Update API key credit limit

Change the lifetime credit ceiling of an API key. Acts on the key that authenticates this request unless target is OTHER. Use set to pin an absolute limit, increase or decrease to adjust it by a number of credits, multiply or divide to scale it, or remove to make the key unlimited. Once a key's usage reaches its limit it can no longer authenticate until the limit is raised or removed.

<span><strong>Rate limit:</strong> 30 requests per 1 minute</span>

<span>💰 <strong>Cost:</strong> FREE! No credits are charged for this API. <span title="Pricing shown is default pricing. Actual pricing may vary."></span></span>

post/v1/api-keys/limit

Request body

apiKeystring required

Your Fiber API key

target'SELF' | 'OTHER'

Which key to act on. SELF acts on the key that authenticates this request. OTHER acts on a different key in your organization, supplied in targetApiKey.

targetApiKeystring nullable

The key to act on when target is OTHER. Must belong to your organization. You can pass prefix, id, or the raw key. Omit when target is SELF.

operation'set' | 'increase' | 'decrease' | 'multiply' | 'divide' | 'remove' required

set: pin an absolute credit ceiling. increase/decrease: adjust the current ceiling by a number of credits. multiply/divide: scale the current ceiling by a factor. remove: make the key unlimited. increase, decrease, multiply, and divide have no effect on an already-unlimited key; use set to establish a ceiling first.

creditsnumber nullable

The credit amount. Required for set (zero or greater), increase, and decrease (greater than zero); ignored otherwise.

factornumber nullable

The factor to scale the current ceiling by. Required for multiply and divide; ignored otherwise.

Response

Default Response

advicestring[] nullable

Tips, recommendations, and suggestions for using this API effectively.