Home / Help centre / Integrations & API
Integrations & API
How do I trigger a Cyberlop scan from my CI pipeline?
Open Integrations, pick your code host tab and a scan profile, click Copy, and save the YAML in your repository. Add CYBERLOP_URL and CYBERLOP_API_TOKEN as secrets. The job starts a scan on each push to main and reports findings without failing the build.
Steps
- Open Integrations in the sidebar and choose the tab that matches your code host.
- Use the Scan profile picker to choose what to scan. The profile's ID goes into the snippet for you.
- Click Copy.
- Save the YAML in your repository as the file the tab names, then commit it.
- Add
CYBERLOP_URLandCYBERLOP_API_TOKENas secrets. Read which secrets to add for the values. - Push to
main, or run the job by hand if your code host offers a manual button.
Good to know
This job does three things, in this order, and each one maps to a step in the log.
| Stage | What it does |
|---|---|
| Trigger | Sends the profile ID and commit to POST /api/ci/scan and keeps the scan ID |
| Wait | Checks GET /api/ci/result/<scan_id> every 30 seconds, up to 120 times |
| Report | Prints the finding count, then severity, title and location for each finding |
The step never blocks your pipeline. You read the results in the build log, one line per finding. Treat it as a report, not a gate: after each push to main, open the build log and read what the scan found before you move on.
Whatever the job scans, it scans with the token owner's permissions and group scope, so pick a token from a user who may run the profile you chose, or the trigger call fails. Wondering how to read the result by hand? See how to check a CI scan's result. The full walkthrough is in add security scanning to your CI/CD pipeline.
Related questions
- How do I copy the ready-made CI workflow for my code host?
- How do I choose which profile my CI job scans?
- Which secrets do I need to add to my repository for CI scans?
- How do I get a personal API token?
- When does the generated CI workflow run?
How to add security scanning to your CI/CD pipeline
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Wiring it into your pipeline?
Share what you are building and we will help you set up the right token, profile and job.