Research Academy
My account Customers About Blog Careers Legal Contact Resellers
The Burp Suite User Forum was discontinued on the 1st November 2024.

Burp Suite User Forum

For support requests, go to the Support Center. To discuss with other Burp users, head to our Discord page.

SUPPORT CENTER DISCORD

Importing OpenAPI v3.0 spec for scan - "Couldn't read the API definition. Review the definition and correct any syntax errors."

Ads | Last updated: May 10, 2024 05:03PM UTC

I used a private repo (hence not sharing) OpenAPI .yaml spec to augment a collection, then used redocly-cli to create a v3.1 SON collection and then used @apiture/openapi-down-convert (npm) to downgrade the v3.1 OpenAPI spec to v3.0 compatible with Burp Suite scanner.. when i attempt to import into Burp Suite pro, i get the error "Couldn't read the API definition. Review the definition and correct any syntax errors." is there any way i can turn on some kind of debugging/verbosity? the error isn't very helpful. tyia!

Hannah, PortSwigger Agent | Last updated: May 13, 2024 12:23PM UTC

Hi We have some additional improvements to API scanning on our Early Adopter channel. Could you check this out and see if you are still experiencing the issue? If you'd like to switch over to Early Adopter, just go to "Settings > Suite > Updates" and change your dropdown from Stable to Early Adopter. After that, if you wait a minute or so, a popup should appear in the top right-hand corner of Burp, with the option to restart your installation. We should have relaxed the YAML parsing slightly as part of these improvements.

Jesse | Last updated: Oct 02, 2024 04:29PM UTC

Hi Hannah, I'm encountering this error today as well, and using the Early Adopter channel has not helped. As the original poster states, lack of error messaging is a real hinderance to resolving this issue independently. Are there any options for identifying what the syntax error is? This schema file validates elsewhere.

Hannah, PortSwigger Agent | Last updated: Oct 03, 2024 12:35PM UTC