Home / Help centre / Integrations & API
Integrations & API
How do I copy the ready-made CI workflow for my code host?
Go to Integrations, open the tab for your code host, choose a scan profile, then click Copy. Paste the YAML into your repository as the file the tab shows, commit it, and add the two secrets the job needs.
Steps
- Click Integrations in the sidebar.
- Pick a tab. The first is a workflow for a code host with Actions. The second is a pipeline for a code host with CI/CD. The third tab is for key vaults, so skip it here.
- Open the Scan profile picker, search by name and select one.
- Click Copy.
- Drop the text into a new file in your repository and commit it.
Good to know
The snippet changes as you change the picker, so choose the profile first and copy after. If you pick another profile later, copy again, because the old text still holds the old profile ID and would keep scanning the wrong thing.
| Tab | File it is meant for |
|---|---|
| First (workflow) | cyberlop-scan.yml in your code host's workflows folder |
| Second (pipeline) | The pipeline file at the root of the repository |
Both versions say in a comment at the top that they are non-blocking. They report findings in the build log and never fail the build, so adding one is a low-risk change to a busy pipeline.
Copying the file is only half the job. The job reads two secrets from your repository settings, CYBERLOP_URL and CYBERLOP_API_TOKEN. Without them the trigger call cannot authenticate. See which secrets to add, or the full trigger walkthrough.
Using a different CI tool? The snippets are examples of the same two API calls. Read what to do for other CI systems.
Related questions
- How do I trigger a Cyberlop scan from my CI pipeline?
- How do I choose which profile my CI job scans?
- Which secrets do I need to add to my repository for CI scans?
- Can I use Cyberlop with a CI system that has no ready-made snippet?
- Where do I store the Cyberlop URL and API token in my CI's settings?
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.