API definition security validation

POST {{baseUrl}}/security/api-validation

Performs an analysis on the given definition and returns any issues based on your [predefined rulesets] This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation.

For more information, see our [Rule violations in the API definition] documentation.

Include the following properties in the request body:

• type — A string value that contains the API definition's type. One of:
  • openapi3
  • openapi2
• language — A string value that contains the API definition's language. One of:
  • json
  • yaml
• schema — A string value that contains the API definition's contents.

Note:

• The maximum allowed size of the definition is 10 MB.
• You must [import and enable] OWASP security rules in Qodex for this endpoint to return any security rule violations.

Body PARAM

HEADERS

RESPONSES

status OK