Missing 500 response

owasp:api2:2019-define-error-responses-500

Rule Severity:

High

Ensure API specifications include definitions for 500 responses.
This rule applies at the API Specification level (OAS/Swagger).
APIs endpoints that do not return HTTP status codes descriptions are more difficult to use for developers. Adding standard responses to API specifications ensures use of those APIs is predictable and safe.

1. How to Identify with Example Scenario

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

responses: '200': # missing '500' response definition description: OK content: text/plain: schema: type: string

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: '500': description: Internal Server Error # a description is required content: text/plain: schema: type: string

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
Insecure host (OAS2)
API key in URL
Undefined integer format
Credentials in URL
Missing global security
Missing authentication

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