How do I download a scan report through the API?

Steps

1. Get a personal API token. An admin issues it from Administration → Users. The token carries its owner's permissions.
2. Find the scan ID. GET /api/scans lists recent scans, newest first, and needs scan:read.
3. Pick a mode, either open, all or fixed-only, and remember that the table below maps each one to a menu option you may already know.
4. Send GET /api/scans/<scan-id>/report.pdf?mode=all from any HTTP client. Add the header Authorization: Bearer <your-token>. Use your Cyberlop address as the host.
5. Write the response body to disk using a name that ends in .pdf.

Good to know

The API Reference page in the app lists every route with its permission, and its filter box lets you type report to find this one quickly. Look for the word "file" beside the path, which marks a route that returns a document, not JSON. Always pass the mode yourself so the result never surprises you.

Authentication is by session cookie or Bearer API token, and for scripts the token is the better choice. A role without scan:read_report cannot fetch the PDF, even if the same role is allowed to list scans.

Treat the token like a password. Store it in your pipeline secret store and never paste it into a ticket or a chat.

This pairs well with CI. A pipeline step can launch a scan, wait for the result and then fetch the report. See how to authenticate API requests and the API reference tutorial. If a call fails, contact us.

Related questions

• How do I authenticate requests to the Cyberlop API?
• How do I get a personal API token?
• How do I find the endpoint I need and the permission it requires?
• How do I download a PDF report for a scan?
• Why does my API call return a permission error?

Full tutorial

Cyberlop API reference: authentication, permissions and the OpenAPI spec

Step-by-step, with annotated screenshots.

Updated 8 October 2026 · Back to the help centre