Create Scan from Wizard

POST

/v2/scans/wizard_create

Last modified:2025-09-01 18:52:30

This endpoint allows you to streamline the process of setting up a scan by creating a target,
a scan for that target, and an optional schedule, all in a single request.
Instead of making three separate API calls to create a target, associate a scan with that target,
and set up a schedule for the scan, you can use this endpoint to simplify and accelerate the workflow.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢201Created

application/json

Scan created

Body

🟠401Unauthorized

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/scans/wizard_create' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
    }
}'

Response Example

201 - Normal 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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Modified at 2025-09-01 18:52:30

List of the running scans

List Reports