Port List Form
The Port List form creates a new port list or edits an existing one. Ports can be entered manually as a comma-separated text field, or imported from the Port Catalog using the catalog picker. Each entry includes a port number and protocol (TCP or UDP).
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 why this list exists | Any text, max 10,000 characters | Empty |
Ports | Comma-separated entries. Each entry is a port (1–65535) optionally suffixed with the protocol (e.g. 22/tcp, 53/udp). Bare numbers default to TCP. | e.g. 22, 80, 443, 3306/tcp, 53/udp | Empty (form rejects submission) |
Catalog Imports | Optional — opens the Port Catalog picker and merges ports from one or more catalog entries (e.g. "Web", "Database"). Imported ports are deduped against what is already in the textarea. | Selection of one or more catalog entries | None |
Gotchas
- Built-in port lists are read-only — the form renders them in disabled mode with a banner and no Save button. To customize, duplicate them as a new list.
- Empty Ports text is rejected with a validation error. The form will not submit until at least one valid port is parsed.
- Invalid port syntax (e.g. "abc", "70000", "22/icmp") is silently dropped during parse. Check that the parsed count matches what you typed before saving — a clean save with fewer ports than expected usually means a typo.
- **When creating:** Names must be unique across all port lists. The API returns a 409 if you reuse an existing name.
- **When editing:** If this list belongs to a port list group or is referenced by a scan template, deleting individual ports affects future scans for every consumer. There is no warning prompt — review the related list before saving.
- Catalog imports are recorded as provenance — the saved port list shows which catalog entries it was built from. This survives editing as long as you don't remove the imported ports.
API calls (3)
| Method | Path | Description |
|---|---|---|
| GET | /api/config/port-lists/:id | Load an existing port list (Edit mode) |
| POST | /api/config/port-lists | Create a new port list (Create mode) |
| PUT | /api/config/port-lists/:id | Update an existing port list (Edit mode) |
Related
- Port Lists — Parent list page — also describes filtering, inline editing, and deletion
- Port Catalog — Source library the catalog picker imports from
- Port List Groups — Groups multiple port lists for use in scan templates
- Scan Templates — Consumes port lists (or port list groups) to define what gets scanned