Skip to main content
POST
/
headless
/
sftp
/
connectors
Create SFTP connector
curl --request POST \
  --url https://app.dromo.io/api/v1/headless/sftp/connectors/ \
  --header 'Content-Type: application/json' \
  --header 'X-Dromo-License-Key: <api-key>' \
  --data '
{
  "credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
  "schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
  "schedule": {
    "type": "every_n_minutes",
    "minutes": 15
  },
  "directory": "/uploads",
  "file_regex": ".*\\.csv$"
}
'
{
  "credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
  "schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
  "schedule": {
    "type": "every_n_minutes",
    "minutes": 15
  },
  "directory": "/uploads",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "file_regex": ".*\\.csv$"
}

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.

Body

application/json
​
credentials
string<uuid>
required

ID of SFTP credentials to use

Example:

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

​
schema
string<uuid>
required

ID of import schema to use

Example:

"f9e8d7c6-b5a4-3210-9876-543210fedcba"

​
schedule
object
required
​
directory
string
required

SFTP directory to monitor

Example:

"/uploads"

​
file_regex
string | null

Optional regex pattern to filter files (null accepts all files)

Example:

".*\\.csv$"

Response

SFTP connector created

​
credentials
string<uuid>
required

ID of SFTP credentials to use

Example:

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

​
schema
string<uuid>
required

ID of import schema to use

Example:

"f9e8d7c6-b5a4-3210-9876-543210fedcba"

​
schedule
object
required
​
directory
string
required

SFTP directory to monitor

Example:

"/uploads"

​
id
string<uuid>
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
file_regex
string | null

Optional regex pattern to filter files (null accepts all files)

Example:

".*\\.csv$"