Create Scan

POST/v2/scans

Last modified: 3 days ago

Create new Scans in your Clone Guard® Security Scanning portal.

Request

scan

object

required

name

string

optional

The scan name

Example:

My Scan

comment

string

optional

The scan comment

Example:

My comment

run_now

boolean

optional

If true, runs the scan after creation

Example:

true

target_id

string <uuid>

optional

The target uuid

schedule_id

string <uuid>

optional

The schedule uuid.

config_id

string <uuid>

optional

The config uuid

scanner_id

string <uuid>

optional

The scanner uuid

{
  "scan": {
    "name": "My Scan",
    "comment": "My comment",
    "run_now": true,
    "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
    "schedule_id": "8929bb67-0da1-406c-99d2-5447376a4f58",
    "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
    "scanner_id": "43593f58-da3f-45f0-a7bf-8763ef29bdf1"
  }
}

Request samples

Responses

Created(201)

Unauthorized(401)

Parameter Error(422)

HTTP Code: 201

Content Type : JSONapplication/json

Scan created

object {0}

{}

Last modified: 3 days ago