--- title: "List scopes" method: GET path: "/scopes" tags: ["scopes"] --- # List scopes `GET /scopes` Returns all scan scopes owned by the current user. ## Response `200` Scopes retrieved - HandlersScopesResponse - `allow_asset` boolean — Whether the user is allowed to create asset scan scopes - `allow_custom` boolean — Whether the user is allowed to create custom scan scopes - `allow_network` boolean — Whether the user is allowed to create network scan scopes - `scopes` HandlersScope[] — List of scan scopes owned by the current user - `attributes` UtilsJsonMap - `connection` HandlersConnection - `database` string - `host` string - `port` integer - `created` string — Timestamp of creation - `created_by` string — User who created this scope - `cycle` integer — The current cycle the scan is in. Relevant, if scanning in cycles is enabled - `cycle_active` number — Percentage of active input scan tasks. Is updated in intervals and not a 100% current. - `cycle_done` number — Percentage of completed input scan tasks. Is updated in intervals and not a 100% current. - `cycle_failed` number — Percentage of failed input scan tasks. Is updated in intervals and not a 100% current. - `cycle_queue` UtilsJsonMap - `cycle_started` string — Timestamp of last cycle start - `cycles` boolean — Scan in cycles - `cycles_retention` integer — Amount of previous scan cycles to keep. Older ones will be cleaned up. - `enabled` boolean — Whether new target should be fed to scan agents for this scan scope - `group_name` string — Expand with additional information useful for the web frontend - `id` integer — Id autoincrement - `last_sync` string — Timestamp when the scan scope targets were set/updated/synchronized the last time - `name` string — Name of the scope selected by the user - `scan_agents` DatabaseTScanAgent[] — The scope's last seen agents. Can be omitted if user should not see them. - `api_version` string - `build_commit` string - `build_timestamp` string - `cpu_cores` integer - `cpu_mhz` number - `cpu_rate` number — Usage in % - `host` string - `id` integer — Id autoincrement - `ip` string - `last_seen` string - `limits` boolean - `memory_bytes` integer - `memory_rate` number — Usage in % - `name` string - `platform` string - `platform_family` string - `platform_version` string - `shared` boolean - `tasks` UtilsJsonMap - `version_nmap` string - `version_npcap` string - `version_python` string - `version_sslyze` string - `scan_settings` DatabaseTScanSetting - `discovery_exclude_domains` string - `discovery_nmap_args` string - `discovery_nmap_args_ot` string — A safer scan executed in OT discovery scans. Field is just required as a JSON field to load default settings from the manager.conf. Not required in the manager database, because it will be copied into the normal nmap args field. - `discovery_nmap_args_prescan` string — A smaller scan executed before the main scan to at least retrieve some scan results, before a potential IDS kicks in - `discovery_timespans` UtilsTimespan[] - `endDay` string - `endTime` string - `startDay` string - `startTime` string - `http_user_agent` string - `max_instances_banner` integer — Maximum parallel instances of banner scans per agent. - `max_instances_discovery` integer — Maximum parallel instances of discovery scans per agent. - `max_instances_nfs` integer — Maximum parallel instances of nfs scans per agent. - `max_instances_nuclei` integer — Maximum parallel instances of nuclei scans per agent. - `max_instances_smb` integer — Maximum parallel instances of smb scans per agent. - `max_instances_ssh` integer — Maximum parallel instances of ssh scans per agent. - `max_instances_ssl` integer — Maximum parallel instances of ssl scans per agent. - `max_instances_webcrawler` integer — Maximum parallel instances of webcrawler scans per agent. - `max_instances_webenum` integer — Maximum parallel instances of webenum scans per agent. - `network_timeout_seconds` integer - `nfs_accessible_only` boolean - `nfs_depth` integer - `nfs_exclude_extensions` string - `nfs_exclude_file_size_below` integer - `nfs_exclude_folders` string - `nfs_exclude_last_modified_below` string - `nfs_exclude_shares` string - `nfs_scan_timeout_minutes` integer - `nfs_threads` integer - `nuclei_exclude_ids` string - `nuclei_exclude_protocols` string - `nuclei_exclude_severities` string - `nuclei_exclude_tags` string - `nuclei_include_ids` string - `nuclei_include_protocols` string - `nuclei_include_severities` string - `nuclei_include_tags` string - `nuclei_scan_timeout_minutes` integer - `ot` boolean — Enable OT discovery mode (PROFINET DCP, EtherCAT, LLDP, NDP, mDNS) with OT-optimized Nmap timing. Agent auto-detects scan targets based on local configuration. - `sensitive_ports` integer[] - `smb_accessible_only` boolean - `smb_depth` integer - `smb_exclude_extensions` string - `smb_exclude_file_size_below` integer - `smb_exclude_folders` string - `smb_exclude_last_modified_below` string - `smb_exclude_shares` string - `smb_forced_shares` string - `smb_scan_timeout_minutes` integer - `smb_threads` integer - `ssh_scan_timeout_minutes` integer - `ssl_scan_timeout_minutes` integer - `webcrawler_always_store_root` boolean - `webcrawler_depth` integer - `webcrawler_follow_query_strings` boolean - `webcrawler_follow_types` string - `webcrawler_max_threads` integer - `webcrawler_scan_timeout_minutes` integer - `webenum_probe_robots` boolean - `webenum_scan_timeout_minutes` integer - `size` integer — Amount of IPs currently within this scan scope. Needs to be calculated/updated during population of the actual scan scope's t_discovery table. - `split_size` integer — Maximum amount of IPs contained in one scan target after large networks are split - `type` string — The kind of scope, there might be different ones initialized via different mechanisms. E.g. custom, remote repository,... ## Other responses - `401` — Unauthorized - `503` — Service Unavailable --- [API](https://skmtc.net/siemens/apis/large-scale-discovery-api.md) · [All operations](https://skmtc.net/siemens/apis/large-scale-discovery-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/siemens/large-scale-discovery-api/versions/cdce1f888ae3/schema)