integrations
collexus

Check Collexus Sftp

Probe the Collexus SFTP server and report what came back.

The creditor's firewall admits only the deployment's NAT egress addresses, so this has to run from inside the stack — and the image carries no ssh client, so an admin route is the way to run it. It answers cleanly on a deployment that has no Collexus configuration at all.

With no COLLEXUS_SFTP_HOST_KEY set the check runs in discovery mode: it reports the server's fingerprint and the key line to pin, having authenticated nothing and transferred nothing. Once pinned, a host key that does not match aborts the connection and the check says so.

post/integrations/collexus/sftp/check

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Response

Successful Response

status'ok' | 'discovery' | 'not_configured' | 'failed' required
detailstring required
mode'pinned' | 'discovery' nullable
hoststring nullable
portinteger nullable
usernamestring nullable
missing_settingsstring[]
reachableboolean
host_key_pinnedboolean
host_key_verifiedboolean
host_key_typestring nullable
host_key_fingerprintstring nullable
host_key_linestring nullable
authenticatedboolean
inbound_pathstring nullable
outbound_pathstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.