Security & delivery
/api/v1/port-checkerPacketFlo Port Checker API
Test whether a TCP port is open from the outside.
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | Hostname or IP address. |
port | number | Yes | TCP port number (1-65535). |
Open Port
TCP connection succeeds immediately within timeout.
Example request
curl "https://packetflo.io/api/v1/port-checker?host=example.com&port=443&api_key=YOUR_API_KEY"
Example response
{ "ok": true, "data": { "host": "example.com", "port": 443, "status": "Open", "responseTime": 56 }, "meta": { "tool": "port-checker", "version": "v1" } }
Closed / Timed Out Port
TCP connection is refused or packets are dropped by a firewall.
Example request
curl "https://packetflo.io/api/v1/port-checker?host=example.com&port=81&api_key=YOUR_API_KEY"
Example response
{ "ok": true, "data": { "host": "example.com", "port": 81, "status": "Timeout", "responseTime": 3000 }, "meta": { "tool": "port-checker", "version": "v1" } }
Reading the result
Open means a TCP connection succeeded; Closed means it was refused. Unreachable, Timeout, Filtered and Error retain distinct failure causes.
Response fields
| Field | What it tells you |
|---|---|
host / port | The requested target and TCP port. |
status | Open, Closed, Unreachable, Timeout, Filtered or Error. |
responseTime | Elapsed connection-check time in milliseconds. |
Scope and limits
Checks one validated public address with a three-second socket timeout. It does not test UDP or complete an application handshake.
Authentication and errors
Send your key in the x-api-key header, or the supported api_key query parameter. Each request uses 1 credit from the key's shared 300-credit rolling 24-hour budget. Credits are charged before parameter validation. Successful responses and quota errors include usage headers; GET and OPTIONS support CORS.
| API status | Meaning |
|---|---|
200 | The diagnostic returned a result in data, with ok: true and version information in meta. Read the diagnostic fields to determine the target's condition. |
400 | Invalid or blocked input, or a lookup/check failure that could not be returned as a diagnostic result. Read error for details. |
401 | Missing, invalid or revoked API key. |
429 | The request would exceed the key's available credit budget. |