How do I download the API spec?

Steps

1. Click API Reference in the sidebar.
2. Look at the top right of the page for two buttons.
3. Choose ⤓ OpenAPI to download the spec in OpenAPI form.
4. Pick ⤓ JSON if you want the endpoint list as plain JSON.
5. Open the saved file in your API client, or feed it to a code generator.

Good to know

Both files cover the same 78 endpoints that the page lists, grouped into 15 sections. Each one carries the permission it requires, so you can plan a token before you write any code. That saves you a round of trial and error, and it lets a reviewer on your team check the permissions a new integration will need before anybody creates the token for it.

Both buttons start a file download, so your browser may ask where to save it. Nothing else needs setting up. If the API Reference is missing from your sidebar, ask an admin, because what you see depends on your role.

Why use the spec instead of the page? The spec is the better source for request bodies. For example, the reference lists the route to launch a scan and its permission, and the downloaded spec is where you check the exact fields. The page itself does not list field names, so open the file for those.

Keep a copy with your project. Download it again whenever you want to check what changed, for example before you upgrade an integration that you built a while ago. For the rest of the page, read how to find an endpoint and its permission. To call the API for the first time, start with how to authenticate requests. A longer tour is in the API reference tutorial.

Related questions

• How do I find the endpoint I need and the permission it requires?
• How do I authenticate requests to the Cyberlop API?
• What can I do with the Cyberlop API?
• How do I launch a scan through the API?
• 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