Home / Help centre / Integrations & API
Integrations & API
Can I use Cyberlop with a CI system that has no ready-made snippet?
Yes. The two ready-made snippets are examples of two API calls, so any CI system that can run curl can do the same. Send POST /api/ci/scan with a Bearer token and a profile ID, then poll GET /api/ci/result/{scanId} until done is true.
The short version
The Integrations page ships snippets for two code hosts. Neither is special. Each one makes the same two web requests, so you can copy the pattern into any pipeline tool that runs a shell step.
How it works in Cyberlop
- Store two values as secrets in your CI system:
CYBERLOP_URL(your app's base URL) andCYBERLOP_API_TOKEN(your personal API token). - Trigger. Send
POST /api/ci/scanwith anauthorization: Bearerheader and a JSON body holdingprofileIdand, if you like,commitSha. The reply gives you ascanId. - Wait. Poll
GET /api/ci/result/{scanId}until the reply saysdoneis true. The shipped snippets poll every 30 seconds, up to 120 times. - Report. Read
totalIssuesand thefindingslist. Each finding has a severity, a title and a location. Print them to the job log.
The in-app documentation describes the same flow under CI/CD and automation. The scan runs with the token owner's permissions and group scope, so use a token whose owner can run that profile.
What to do next
- Copy a snippet as a starting point: how to copy the CI snippet.
- Learn the trigger call in launching a scan with the API.
- See the polling call in polling a scan result.
The snippets never fail your build. If you want a failing gate, you decide the rule in your own script, using the counts the result call returns. Our CI/CD integration tutorial walks through the whole setup, and the idea of gating a build explains the trade-off.
Related questions
- How do I copy the ready-made CI workflow for my code host?
- How do I launch a scan through the API?
- How do I check a CI-triggered scan's result through the API?
- Which secrets do I need to add to my repository for CI scans?
- Why did my CI job pass even though Cyberlop found critical issues?
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.