Get Project Scan Configuration

get

https://{hostname}/api/v2/projects/{projectID}/scanparams

This endpoint retrieves security creteria of the specific project.

Path Params

{projectID}

string

required

ID of the project

Query Params

start

int32

Defaults to 0

Start of the pagination

limit

int32

Defaults to 30

Limit of the pagination

manual

boolean

meta_data

string

tool_id

string

Tool ID of scan param

branch

string

Branch of the scan

fork_scan

boolean

Check scan param is a fork scan. Compares with project's main branch. If you compare with another branch, you must specify branch with fork_source_branch query parameter

target

string

Target ALM of the scan param. You must to set pr query parameter as true.

agent

string

Agent of the scan param

string

Check scan param is a PR

environment

string

Environment of scan param. Accepts: production, feature, staging, development

fork_source_branch

string

Custom branch name for fork_scan query parameter

Headers

X-Cookie

string

required

Defaults to Token

Personal Access Token

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200200

400400

401401

403403