Sign in

v3

latestSwagger 2.0MITraw.githubusercontent.com2026-08-0131321.1 KB
scopes

Create or update custom scope

Creates a new custom scan scope or updates an existing one with scan targets. Supply group_id for creation or scope_id for update. Requires ownership.

post/scope/update/custom

Request body

cyclesboolean

Whether to enable cyclic scanning

cycles_retentioninteger

Amount of scan cycles to keep. -1 to keep all. 0 not allowed.

group_idinteger

Set if NEW scope shall be created

namestring

Name of the scan scope

otboolean

Whether this is an OT discovery scope

scope_idinteger

Set if EXISTING scope shall be updated

split_sizeinteger

Maximum amount of IPs per split scan target

Example request

{
  "cycles_retention": 3,
  "group_id": 1,
  "name": "My Scope",
  "scope_id": 42,
  "split_size": 2048
}

Response

Scope created or updated

warningsstring[]

List of warnings generated during target processing