Skip to main content

Troubleshooting Guide: Resolving 429 Too Many Requests (Client Error)

Distributor/API user troubleshooting for a 429 Too Many Requests error in Encompass integrations: check burst traffic, retry backoff and overlapping scheduled jobs. Requires v26.01+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 26.01

Pre-Conditions

  • Must be using an application, integration, or automated script that makes HTTP requests to an API endpoint.

  • Must be authenticated via a unique user, IP address, or API access key.

  • Must have encountered a "429 Too Many Requests" HTTP status code.

Steps

  • Verify the exact nature of the traffic to determine if sudden burst traffic is exceeding throttle thresholds.

  • Check your client application's error-handling logic to ensure it is not initiating a retry storm without proper exponential backoff.

  • Review your system's scheduled tasks to confirm that multiple automation jobs are not hitting the same endpoint within an identical window.

  • Audit your overall request volume to determine if the rate limit has been exceeded per your unique user, IP address, or API access key.

  • If the issue persists after reviewing your traffic and retry logic, please contact support. You must gather and provide the following specific information for efficient troubleshooting:

    • Exact error messages or codes encountered.

    • Screenshots or video recordings of the issue.

    • Log files (specifically API or network request logs).

    • The exact steps taken by the customer that led to the issue.

    • The date and time the issue was first observed and any recurrence.

    • Any changes made to the system before the issue appeared.

Fields And Definitions

  • 429 Too Many Requests: An HTTP Client Error status indicating that the requester has sent too many requests in a given amount of time.

  • API Access Key: A unique token used to identify and authorize a client; rate limits are often applied against this key.

  • Throttle Thresholds: The maximum allowable limits for sudden burst traffic before requests are rejected by the server.

  • Retry Storm: A rapid succession of repeated requests initiated by clients that fail to use proper delay mechanisms after an initial error.

  • Exponential Backoff: A standard error-handling strategy where a client increases the delay time between consecutive retry attempts.

Best Practices

  • Implement proper exponential backoff algorithms in all custom clients or integrations to prevent retry storms.

  • Stagger the execution times of scheduled automation jobs so they do not concurrently hit the same endpoint within an identical time window.

  • Monitor your API integrations for sudden burst traffic to ensure you remain below the designated throttle thresholds.

  • Distribute heavy workloads across different time periods to avoid exceeding rate limits tied to your unique user, IP address, or API access key.

Did this answer your question?