HTTPAPIBudget

Defines how many requests can be made to the API in a given time frame. HTTPAPIBudget extracts the remaining call count and the reset time from HTTP response headers using the header names provided by ratelimit_remaining_header and ratelimit_reset_header. Only requests using HttpRequester are rate-limited; custom components that bypass HttpRequester are not covered by this budget.

• type: object
• required: ["type","policies"]

type

• Required: Yes
• type: string
• enum: ["HTTPAPIBudget"]

policies

List of call rate policies that define how many calls are allowed.

• Required: Yes

• type: array

• items:

  • anyOf:

    • Allowed type: FixedWindowCallRatePolicy

  • anyOf:

    • Allowed type: MovingWindowCallRatePolicy

  • anyOf:

    • Allowed type: UnlimitedCallRatePolicy

ratelimit_reset_header

The HTTP response header name that indicates when the rate limit resets.

• Required: No
• type: string
• default: ratelimit-reset

ratelimit_remaining_header

The HTTP response header name that indicates the number of remaining allowed calls.

• Required: No
• type: string
• default: ratelimit-remaining

status_codes_for_ratelimit_hit

List of HTTP status codes that indicate a rate limit has been hit.

• Required: No

• type: array

• default: [429]

• items:

  • type: integer