Type: tcp_port | Runner: Dashboard or Agent
Attempts to open a TCP connection to a host and port. Succeeds if the connection is accepted within the timeout. Does not send or receive any data — it only tests that the port is open and accepting connections.
host:port can be established within the timeout| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
host |
text | Yes | — | Hostname or IPv4 address to connect to. IPv6 literals are not currently supported; use a hostname that resolves to IPv6 if needed. |
port |
number | Yes | 80 |
TCP port number (1–65535) |
timeout |
number | No | 5 |
Connection timeout in seconds (1–60). Default: 5. |
| Status | Condition |
|---|---|
| OK | TCP connection established — message: host:port reachable |
| Fail | Connection refused, timed out, or host unreachable |
| Unknown | No host configured, or invalid port number |