Skip to main content
ZStack
Infrastructure/Installer

ProbeTCP

Probe TCP connectivity to a given host and port from the installer node

POST/api/v1/installer/probe/tcp

Operation ID

ProbeTCP

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • host
    StringRequired

    Hostname or IP address to probe

    Example: 192.168.1.10

  • port
    IntegerRequired

    TCP port number to probe

    Example: 5432

  • timeoutMs
    IntegerRequired

    Connection timeout in milliseconds; default 5000, max 30000

    Example: 5000

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • reachable
    Boolean

    Whether the TCP port is reachable

    Example: true

  • error
    String

    Error message if the probe failed

    Example: connection refused