Probe a CPE device by MAC address. Runs ICMP ping, reverse DNS lookup, OUI manufacturer lookup, and nmap OS/service scan concurrently. Looks up the device's last known IP from DHCP event history
POST /api/devices/{mac}/probe
Auto-generated from server.go. Handler: s.diagnosticsHandler.ProbeDevice.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Example
aa:bb:cc:dd:ee:ffFull MAC address with colon or hyphen separators.
Request Body
Section titled “Request Body ”Optional ICMP / probe parameters. All fields are optional; omitted values fall back to the ProbeManager defaults (3 pings, 64-byte payload, OS default TTL, 2-second per-ping timeout, IPv4 protocol).
object
Number of ICMP pings to send (default 3).
ICMP payload size in bytes (default 64).
ICMP TTL; 0 means “OS default”.
Timeout per ping in milliseconds (default 2000).
Ipv4 or ipv6 (default ipv4).
Responses
Section titled “ Responses ”Successful response
Aggregate result of an on-demand device probe. Combines ICMP ping results, reverse DNS, OUI manufacturer lookup, and an nmap OS/service scan. Mirrors diagnostics.ProbeResult (internal/diagnostics/types.go).
Hand-lifted in Session 9 (no prior schema existed).
object
Information about a single open port, as reported by nmap. Mirrors diagnostics.PortInfo (internal/diagnostics/types.go).
object
TCP/UDP port number (0-65535).
Tcp or udp
Nmap port state (open, closed, filtered, …)
Service name as detected by nmap.
Service version banner (optional).
Per-probe errors (DNS, ping, nmap). Omitted by the handler when empty (json:“errors,omitempty”).
The request body or parameters failed validation.
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
A URI reference that identifies the problem type.
A short human-readable summary of the problem.
The HTTP status code generated by the origin server.
A human-readable explanation specific to this occurrence.
A URI reference that identifies the specific occurrence.
Legacy error message field. Will be removed once handlers are migrated.
Legacy per-field error details. Will be removed once handlers are migrated.
object
The request id middleware-assigned identifier for tracing.
Authentication is required or the supplied token is invalid.
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
A URI reference that identifies the problem type.
A short human-readable summary of the problem.
The HTTP status code generated by the origin server.
A human-readable explanation specific to this occurrence.
A URI reference that identifies the specific occurrence.
Legacy error message field. Will be removed once handlers are migrated.
Legacy per-field error details. Will be removed once handlers are migrated.
object
The request id middleware-assigned identifier for tracing.
The requested resource was not found.
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
A URI reference that identifies the problem type.
A short human-readable summary of the problem.
The HTTP status code generated by the origin server.
A human-readable explanation specific to this occurrence.
A URI reference that identifies the specific occurrence.
Legacy error message field. Will be removed once handlers are migrated.
Legacy per-field error details. Will be removed once handlers are migrated.
object
The request id middleware-assigned identifier for tracing.
Internal server error
Standardised error envelope per RFC 7807. Many existing endpoints still
return an older shape (e.g. {"error": "..."}). This schema documents the
target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the
spec describes current behaviour without enforcing the migration here.
object
A URI reference that identifies the problem type.
A short human-readable summary of the problem.
The HTTP status code generated by the origin server.
A human-readable explanation specific to this occurrence.
A URI reference that identifies the specific occurrence.
Legacy error message field. Will be removed once handlers are migrated.
Legacy per-field error details. Will be removed once handlers are migrated.
object
The request id middleware-assigned identifier for tracing.