Missing retry header

owasp:api4:2019-rate-limit-retry-after

Rule Severity:

High

Ensure that APIs returning 429 responses contain a Retry-After header.
This rule applies at the API Specification level (OAS/Swagger).
Endpoints should use proper rate limiting to ensure service availability to all users. The Retry-After header indicates how long a user of an API will need to wait before making a new request.

1. How to Identify with Example Scenario

Find the text in bold to identify issues such as these in API specifications

responses: '429': description: Rate limit exceeded # Missing Retry-After header

2. How to Identify with Example Scenario

Find the text in bold to identify issues such as these in API specifications

1. How to Resolve with Example Scenario

Find the text in bold to identify issues such as these in API specifications

responses: '429': description: Rate limit exceeded headers: Retry-After: description: Indicates how long the client should wait before making a follow-up request. schema: type: string # example: 'Mon, 7 Aug 2023 07:28:00 GMT' # optionally add examples for both date and delay-seconds examples: http-date: value: 'Mon, 7 Aug 2023 07:28:00 GMT' delay-seconds: value: '120'

2. How to Resolve with Example Scenario

Modify the text in bold to resolve issues such as these in API specifications
References:

More findings

All Findings
Numeric IDs
Missing 429 response
Insecure host (OAS2)
Unrestricted string
Missing 401 response
Missing additional properties

Resource center

Check the FireTail blog and research documents for up-to-date information.

FireTail Now Available on AWS Marketplace
September 27, 2023

FireTail Now Available on AWS Marketplace

The addition of FireTail marks a significant milestone in our mission to provide state-of-the-art API security solutions to organizations around the world. Now, AWS customers can unleash the power of FireTail quickly, easily and confident in the knowledge that the platform integrates perfectly with their cloud environment.

Read more
FireTail Secures SOC 2 Type 2 Certification
September 15, 2023

FireTail Secures SOC 2 Type 2 Certification

At FireTail, we are very pleased to announce that we have achieved SOC 2 Type 2 accreditation. This certification is an important milestone in our ongoing journey to ensure we adhere to the highest industry standards when it comes to data protection and cybersecurity.

Read more
The Complex Connections between Generative AI and API Security
September 14, 2023

The Complex Connections between Generative AI and API Security

APIs and Artificial Intelligence are two of the most important developments in tech of the last 10 years. In this post, we look at the dual impacts that connect these two hot topics that make our online worlds work.

Read more
Browse all articles