Rivier/ Reference/ usage

One allowance in full

get/usage/limits/{meter}

Before you call

Credential
Authorization: Bearer $KEY
Scope
usage:read
Graphql
Query.usageLimitGet
Sdk
usage.limit.get
Cli
usage limit get

Parameters

  • meterstringrequired
    In the path

Responses

  • 200application/json
    Success
    • meterstringrequired
    • labelstringrequired
    • unitstringrequired
    • periodstringrequired
    • resetsAtstring or nullrequired
    • includednumberrequired
    • capacitynumberrequired
    • usednumberrequired
    • heldnumberrequired
    • remainingnumberrequired
    • sharenumberrequired
    • statestringrequired
      One of: ok, warn, over, off.
    • policyobjectrequired
      • overagestringrequired
        One of: block, bill, approve.
      • warnAtlist of numberrequired
      • hardOveragenumber or nullrequired
      • approvalBlocknumber or nullrequired
      • projectCapnumber or nullrequired
      • pooledbooleanrequired
    • poolDrawsnumberrequired
    • overagenumberrequired
    • approvednumberrequired
    • poolobject or nullrequired
    • projectCapRemainingnumber or nullrequired
  • 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

This page as Markdown