Home / Help centre / Integrations & API
Integrations & API
Can I trigger a CI scan by profile name instead of profile ID?
Yes. POST /api/ci/scan takes either profileId or profileName, plus an optional commitSha. The snippet from Integrations writes the ID, but you can send the name instead. The owner of the token needs the ci:trigger permission.
The short version
Yes. The CI route accepts a profile by ID or by name, so pick whichever is easier for your team to read in a pipeline file.
How it works in Cyberlop
The API reference describes POST /api/ci/scan as triggering a scan by profileId or profileName, with an optional commitSha. The permission is ci:trigger.
The ready-made job on Integrations writes the ID, because an ID never changes when someone edits the profile. It sends a JSON body with profileId and commitSha. To use the name, swap the first key and keep the rest as it is.
| Body key | Value | Best when |
|---|---|---|
profileId | The profile's ID | You want an exact match that survives renames |
profileName | The profile's name | You want the file to read clearly in review |
The trade-off is simple. A name reads well in a code review, so a colleague can see what the job scans without opening the app. An ID is exact, and it will not break if someone renames the profile or creates a second profile with a similar name. If you do rename a profile, update any job that sends the old name.
What to do next
- Copy the ready-made job from Integrations first, so the rest of the workflow is correct.
- Change the profile field only if you want the name.
- Check the build log after the next run. If the trigger step fails, see why a CI job cannot trigger a scan.
The full setup is in how to trigger a scan from CI. To choose between profiles, read how to choose which profile your job scans.
Related questions
- How do I trigger a Cyberlop scan from my CI pipeline?
- How do I choose which profile my CI job scans?
- How do I copy the ready-made CI workflow for my code host?
- Can I scan a specific commit instead of the latest one?
- My CI job can't trigger a scan. What should I check?
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.