Test SFTP connection

POST

headless

sftp

credentials

{id}

test_connection

Test SFTP connection

curl --request POST \
  --url https://app.dromo.io/api/v1/headless/sftp/credentials/{id}/test_connection/ \
  --header 'X-Dromo-License-Key: <api-key>'

{
  "success": true,
  "error": "Connection refused"
}

Authorizations

X-Dromo-License-Key

string

header

required

This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.

Path Parameters

string<uuid>

required

SFTP credentials ID

Example:

"ee5d0e45-b098-47bc-8217-e93790243dfa"

Response

200 - application/json

Connection test result

success

boolean

Example:

true

error

string

Example:

"Connection refused"

List SFTP connectors

⌘I

Test SFTP connection

curl --request POST \
  --url https://app.dromo.io/api/v1/headless/sftp/credentials/{id}/test_connection/ \
  --header 'X-Dromo-License-Key: <api-key>'

{
  "success": true,
  "error": "Connection refused"
}