Rate Limiter

Rate Limit Limit

Changed on

Rate Limiter Check and Consume

post/api/v1.rate-limit.limit

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namespacestring nullable
keystring required
tokensinteger

Number of tokens to consume (default: 1)

Example request

{
  "namespace": "some_namespace",
  "key": "some_key"
}

Response

allowedboolean required

Whether the request is allowed

remaininginteger required

Number of tokens remaining

retry_after_msinteger nullable

Milliseconds until enough tokens are available (only present when allowed is false)

Changes

  • eef244bc652dRevision changes
    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9\-/_.=+:]+$ to ^[a-zA-Z0-9\-/_.=+:{}]+$

  • a542ced3f593Revision changes
    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status