Home / Help centre / Integrations & API
Integrations & API
Which secrets do I need to add to my repository for CI scans?
Add two secrets to your repository: CYBERLOP_URL, the base URL of your Cyberlop app, and CYBERLOP_API_TOKEN, your personal API token. The generated job reads both in every step. The scan runs with the token owner's permissions and group scope.
Steps
- Copy the base URL of your Cyberlop app, with no path after the host name.
- Get your personal API token. An admin issues it from Administration → Users. See how to get a personal API token.
- Open the secrets page of your repository in your code host.
- Name the first secret
CYBERLOP_URLand paste the URL as its value. - Give the second secret the name
CYBERLOP_API_TOKENand paste your token as its value, then save both.
Good to know
| Secret name | What to enter |
|---|---|
CYBERLOP_URL | The base URL of your Cyberlop app |
CYBERLOP_API_TOKEN | Your personal API token |
The footer on the Integrations page repeats this advice: add these two secrets to your repository. Every step of the generated job reads them from the repository secrets, so the names must match exactly, including the capital letters.
Keep the token out of the YAML file. Anything you paste into a committed file is visible to everyone with access to the repository, while a secret stays hidden in the build log.
Remember that the scan runs with the token owner's permissions and group scope, which means a token from someone who cannot run the profile makes the trigger call fail. Read whose permissions a CI scan runs with for the detail. If the job still cannot start a scan, work through why a CI job cannot trigger a scan.
Related questions
- Where do I store the Cyberlop URL and API token in my CI's settings?
- How do I get a personal API token?
- Whose permissions does a CI-triggered scan run with?
- My CI job can't trigger a scan. What should I check?
- How do I trigger a Cyberlop scan from my CI pipeline?
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.