Research Academy
My account Customers About Blog Careers Legal Contact Resellers

Burp Suite User Forum

Create new post

How to see the documentation of rest api

Prasuna | Last updated: Jan 29, 2019 06:24AM UTC

II installed the beta version of burp , and able to access http://localhost:1337/v0.1/ using key. But I want to see the documentation of rest api , how do I do that I tried http://localhost:1337/v0.1/<key>/api-docs it does not work

Liam, PortSwigger Agent | Last updated: Jan 29, 2019 09:37AM UTC

Prasuna, are you using Burp Pro? You just need to remove the version number: http://localhost:1337//<key> Please let us know if you need any further assistance.

Burp User | Last updated: Feb 04, 2019 10:11AM UTC

Thank you for your response. I am using burpsuite_pro_v2.0.13beta.jar where I am not able to open the api docs with and without version. How do I see documentation for rest in this case? I have Burp Pro but that does not have REST API, I tried to update from UI via Help menu , but it fails to update . Is there any other way I can update?

Liam, PortSwigger Agent | Last updated: Feb 04, 2019 11:36AM UTC

What do you see in your browser when you try to access the API? Do you see an error message when you attempt to update? Are you working behind a firewall or corporate proxy?

Burp User | Last updated: Feb 04, 2019 04:01PM UTC

Two issues here: Issue 1: With burp sarted using burpsuite_pro_v2.0.13beta.jar . When I try to access (1) "http://localhost:1337//v0.1 --------- It works fine I can see some rest api's (2) "http://localhost:1337//v0.1/api-docs ------ I get error like {"error":"Not found"} why ?? =================================================== Issue 2: With burp started using burpsuite_pro_v1.7.37.jar, when I try to Update from Help -->Check for updates , it says "Failed to check for Updates..". I use VPN to connect to our corporate network.

PortSwigger Agent | Last updated: Feb 04, 2019 04:23PM UTC

Hi Prasuna, Thanks for following up. We recommend learning about the REST API using the interactive query builder that you've got at http://localhost:1337/v0.1/ There is also an OpenAPI schema at http://127.0.0.1:1337/v0.1/openapi.json There isn't anything at /api-docs/ The update process relies on Burp being able to contact https://portswigger.net/ If you're on the VPN you may need to configure an upstream proxy. Please let us know if you need any further assistance.

Burp User | Last updated: Feb 05, 2019 06:29AM UTC

Thanks Paul. I did configure an upstream proxy under user options , but update process from Help menu doee not work. Other options of Help menu work fine. Any other way to check if Burp is able to contact "https://portswigger.net/" ??

PortSwigger Agent | Last updated: Feb 05, 2019 10:16AM UTC

Hi Prasuna, You can use the Collaborator Health check to verify this. Look in Project options > Misc > Burp Collaborator Server. Run the health check, take a screenshot. Then try enabling "Poll over unencrypted HTTP" and run the healthcheck again. If you can send both screenshots, we can diagnose. It may be that you're behind an SSL-breaking upstream proxy and you need to install the upstream cert in your Java keystore. Please let us know if you need any further assistance.

You must be an existing, logged-in customer to reply to a thread. Please email us for additional support.