Skip to main content
API Explorer|API Explorer
Infrastructure/Installer
POSTInstallerSince 1.0SynchronousAuth Required

ProbeTCP

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • hostStringRequired

    Hostname or IP address to probe

    Example: 192.168.1.10

  • portIntegerRequired

    TCP port number to probe

    Example: 5432

  • timeoutMsIntegerRequired

    Connection timeout in milliseconds; default 5000, max 30000

    Example: 5000

Responses

200 OK

On success, this API returns the following response structure.

  • reachableBoolean

    Whether the TCP port is reachable

    Example: true

  • errorString

    Error message if the probe failed

    Example: connection refused

Endpoint

POST/api/v1/installer/probe/tcp

/api/v1/installer/probe/tcp

Operation ID

ProbeTCP

Permalink

Request Example

curl -X POST '{host}/api/v1/installer/probe/tcp' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"host":"192.168.1.10","port":5432,"timeoutMs":5000}'

Response Example

200
{
  "reachable": true,
  "error": "connection refused"
}

Change History

This API has no change history records yet.

View all change history