Home / Help centre / Scan profiles
Scan profiles
How do I preview the YAML config a profile generates?
Click Preview YAML at the bottom of the New scan profile or Edit scan profile page. Cyberlop shows the scanner config it generates from your form and checks the form at the same time. A red banner names any field that needs fixing. Secrets are not part of the preview.
Steps
- Go to Scan Profiles in the sidebar. Click + New profile, or click the pencil icon on a profile you want to check.
- Fill in the Scope, Authentication and Reporting sections. Use the switcher on the left to move between them.
- Click Preview YAML in the footer. It sits beside Save and is shared by all three sections.
- Read the generated config. Look for the vulnerability classes you ticked, your focus and avoid rules, and the report filters.
- If a red banner appears, read it. It names the field that failed. Fix that field and click Preview YAML again.
- When the preview looks right, click Save.
Good to know
The preview does two jobs. It shows what the scanner will receive, and it validates the form. An empty name, for example, gives the message name: String must contain at least 1 character(s). Our guide to that message is at What does the name error mean.
The API reference lists a matching endpoint, POST /api/profiles/preview-yaml. It previews the scanner config and carries no secrets, so the same rule holds in the app: passwords, tokens and client secrets stay out of the preview.
Preview is a check, not a save. Press Save as a separate step. A preview on a new profile is a good habit before the first scan, because a wrong class list or a missing rule is cheap to fix now and costly to find after a long run.
| Button | What it does |
|---|---|
| Preview YAML | Shows the generated config and validates the form |
| Save | Stores the profile |
| Cancel | Leaves the form (top right) |
For the full form walk-through, see how to create a scan profile.
Related questions
- What does "name: String must contain at least 1 character(s)" mean?
- Why doesn't the YAML preview show my passwords or tokens?
- How do I create a scan profile?
- How do I move between Scope, Authentication and Reporting in a profile?
- How do I edit an existing scan profile?
How to create a scan profile in Cyberlop: Scope, Authentication, Reporting
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Still stuck?
Tell us what you see on screen and an engineer will help you sort it out.