Host and Port Lists

What lists are

A host list or port list is a named set you can drop into a scan by name. The scan request puts host list names in hosts and port list names in ports, mixed with literal IPs and port numbers. Create returns 201.

Host lists

POST/v3/lists/hosts

Create a host list

API reference

Field	Notes
`name`	The string you later put in `hosts`
`description`	Optional note
`hosts`	IPs, ranges, or CIDRs

curl -sS -X POST "https://api.efflux.io/v3/lists/hosts" \
  -H "Authorization: Bearer $EFFLUX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my_internal_servers",
    "description": "Office edges",
    "hosts": ["203.0.113.10", "203.0.113.0/28"]
  }'

GET/v3/lists/hosts

List host lists

API reference

GET/v3/lists/hosts/{list_id}

Get a host list

API reference

PUT/v3/lists/hosts/{list_id}

Replace a host list

API reference

DELETE/v3/lists/hosts/{list_id}

Delete a host list

API reference

The response includes list_id, host_count, and version.

Port lists

POST/v3/lists/ports

Create a port list

API reference

Field	Notes
`name`	The string you later put in `ports`
`description`	Optional note
`ports`	Port numbers or ranges
`proto`	`tcp` or `udp`

curl -sS -X POST "https://api.efflux.io/v3/lists/ports" \
  -H "Authorization: Bearer $EFFLUX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my_common_ports",
    "description": "Admin surfaces",
    "ports": ["22", "443", "3389"],
    "proto": "tcp"
  }'

GET/v3/lists/ports

List port lists

API reference

GET/v3/lists/ports/{list_id}

Get a port list

API reference

PUT/v3/lists/ports/{list_id}

Replace a port list

API reference

DELETE/v3/lists/ports/{list_id}

Delete a port list

API reference

Both lists default to limit 20 (max 200). How many lists you can keep, and how large each one can be, is on GET /limits.