Set what happens at the limit for one allowance

put/usage/limits/policy/{meter}

Set what happens at the limit for one allowance: stop, carry on and bill the overage, or ask a person; the warning levels; a ceiling on overage; a limit for this project alone.

Before you call

Credential: Authorization: Bearer $KEY
Scope: usage:admin
Graphql: Mutation.usageLimitSet
Sdk: usage.limit.set
Cli: usage limit set

Parameters

meterstringrequired
In the path

Request bodyapplication/json, required

overagestring
One of: block, bill, approve.
warnAtlist of number
hardOverageinteger or null
approvalBlockinteger or null
projectCapinteger or null

Responses

200application/json
Success
- overagestringrequired
  One of: block, bill, approve.
- warnAtlist of numberrequired
- hardOveragenumber or nullrequired
- approvalBlocknumber or nullrequired
- projectCapnumber or nullrequired
- pooledbooleanrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X PUT 'https://api.rivier.ai/usage/limits/policy/{meter}' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "overage": "block",
  "warnAt": [
    0
  ],
  "hardOverage": 0,
  "approvalBlock": 0,
  "projectCap": 0
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown