CG Scanning API V2latest
Create Scan from Wizard
POST/v2/scans/wizard_createLast modified: 3 days ago
Create new Scans in your Clone Guard® Security Scanning portal.
Request
Body Params application/json
scan
object
optional
name
string
required
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>
required
The target uuid
target
object
optional
schedule_id
string <uuid>
optional
The schedule uuid.
schedule
object
optional
config_id
string <uuid>
optional
The config uuid
scanner_id
string <uuid>
optional
The scanner uuid
Example
{
"scan": {
"name": "My Scan",
"comment": "My comment",
"run_now": true,
"target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
"target": {
"name": "My Target",
"hosts": "155.168.1.0/24",
"exclude_hosts": "155.168.1.55",
"comment": "my comment"
},
"schedule_id": "8929bb67-0da1-406c-99d2-5447376a4f58",
"schedule": {
"name": "My Schedule",
"comment": "My comment",
"period": 4,
"period_unit": "day",
"first_time": "2023-11-25 19:21:14 UTC",
"timezone": "UTC",
"bymonthday": "1",
"byday": "1SU"
},
"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
Data Schema
object {0}
ExampleNormal response example
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the scan"
},
"comment": {
"type": [
"string",
"null"
],
"nullable": true,
"description": "Comment about the scan"
},
"creation_time": {
"type": "string",
"format": "date-time"
},
"modification_time": {
"type": "string",
"format": "date-time"
},
"editable": {
"type": "bool",
"description": "True if scan can be modified"
},
"app_type": {
"type": "string"
},
"status": {
"type": "string",
"description": "Status of the scan"
},
"schedule_next_time": {
"type": "string",
"description": "Next time the scan will run",
"nullable": true
},
"target": {
"type": "object",
"description": "Target of the scan",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
}
},
"scan_enabled": {
"type": "bool",
"description": "True if scan is enabled"
},
"end_time": {
"type": [
"string",
"null"
],
"format": "date-time",
"nullable": true
}
}
}
}
}
}
}
}
}
}Last modified: 3 days ago