Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Json report format #243

Open
httpnotonly opened this issue Jan 18, 2025 · 1 comment
Open

Json report format #243

httpnotonly opened this issue Jan 18, 2025 · 1 comment

Comments

@httpnotonly
Copy link

Hey guys
I'd like to integrate your tool with my ASOC platform, but you don't have a json report format

It seems to be not difficult to code, but still needed

@emmanuelgautier
Copy link
Member

Hello @httpnotonly,

First of all, thanks for considering integrating VulnAPI with your ASOC platform!
You can export scan reports in JSON format. A documentation should definitely be written about that part.
In addition, for now only file export is available but a way to send it through HTTP is planned (#181)

Here is an example of how to get the report as JSON file:

scan <curl|openapi> ... --report-format json --report-file report.json

The JSON format follows JSON Schemas available on the cerberauth/schemas repository.

To explore all available options and flags, you can run the following command:

vulnapi scan <curl|openapi> --help

We had some discussions about the file format and the data structure of these reports on the project Discord. Feel free to join and share your thoughts.

Lastly, we'd love to hear about your experience integrating this project, your feedback would be interesting in helping the project to be improves!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants