Port Lists

Port lists define named collections of TCP/UDP ports for scanning. Ports can be entered manually or imported from the port catalog. A single port list can be reused across multiple scan templates. Port lists that belong to a group or are referenced by a scan template are protected from deletion.

Inputs

Name Description Allowed Values Default
Name Human-readable label for this port list Non-empty string, must be unique across port lists
Description Optional free-text note about this list Any text, max 10,000 characters Empty
Ports Port numbers with optional protocol Comma/space/newline separated, 1-65535, format: port or port/protocol TCP if protocol omitted
Rate Limit Maximum probes per second when scanning ports in this list, protecting sensitive services Integer 0–100,000 0 (unlimited)

Fields & Columns

Name Description
Name Editable inline — the port list label. Links to the edit form.
Description Editable inline — optional note
Total Ports Count of ports defined in this list
Rate Limit Editable inline — max probes per second for this port list, or "—" if unlimited
Ports Preview of the first few port numbers in this list

How To

Import Ports from Catalog

  1. Click "Add Port List" or edit an existing list.
  2. Click "Add from Catalog" above the Ports field.
  3. Select one or more catalog entries and confirm.
  4. Duplicate ports are automatically skipped. Review the merged list and save.

Gotchas

  1. Changes to a port list automatically apply to all scan templates that reference it.
  2. Port lists used in a scan template or belonging to a group cannot be deleted — remove the references first.
  3. Catalog imports are a one-time copy. If a catalog entry is later updated (e.g., new ports added for a service), you must re-import from the catalog to pick up the changes — existing port lists are not automatically updated.
  4. The rate limit here is one of three levels (scanner, subnet, port list) — the most restrictive (lowest non-zero) value wins at scan time. A value of 0 means unlimited at this level, deferring to the other two levels.

API Calls (6)

Method Path Description
GET /api/config/port-lists List all port lists
POST /api/config/port-lists Create a new port list
PUT /api/config/port-lists/:id Update an existing port list
DELETE /api/config/port-lists/:id Delete a port list (if unreferenced)
GET /api/config/port-lists/:id/details Get port list details with all port entries
GET /api/config/port-lists/filter-values Get available filter values for the port lists table

Related Pages