Create New Scan

post

https://{hostname}/api/v2/scans/create

This endpoint allows you to create a new scan with specified parameters for a project. You can access the "custom" information in the body parameters from the Scanner details.

Body Params

scanparams_id

string

required

The unique identifier for the scan parameters.

branch

string

required

The branch of the project where the scan will be conducted (e.g., "master").

meta_data

string

Additional metadata associated with the scan.

project

string

required

The unique identifier of the project.

tool_id

string

required

The unique identifier for the scanning tool to be used (e.g., "650c518c7495187ed927cd22").

object

custom

object

fork_scan

boolean

Indicator whether the scan is a fork scan.

fork_source_branch

string

The source branch for the fork scan.

override_fork_source_branch

boolean

Indicator whether to override the fork source branch.

environment

string

The environment in which the scan will be conducted.

scheduled

boolean

Defaults to false

Indicator whether to create scheduled scans.

api_rrule

object

Schedule scan rule configuration

Headers

X-Cookie

string

required

Personal Access Token

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200200

400400