Rivier/ Reference/ usage

Every allowance of the project this period

get/usage/limits

Every allowance of the project this period: included, used, what is left, when it resets, the project's choice at the limit, and whether the organisation pools it.

Before you call

Credential
Authorization: Bearer $KEY
Scope
usage:read
Graphql
Query.usageLimitList
Sdk
usage.limit.list
Cli
usage limit list

Responses

  • 200application/json
    Success
    • meterslist of objectrequired
      • 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