v6

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-29251563.8 KB

sftp-connectors

Retrieve SFTP connector

get/headless/sftp/connectors/{id}/

Path parameters

idstring uuid required

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

SFTP connector ID

Response

SFTP connector details

idstring uuid

credentialsstring uuid required

ID of SFTP credentials to use

schemastring uuid required

ID of import schema to use

directorystring required

SFTP directory to monitor

file_regexstring nullable

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

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "credentials": "ee5d0e45-b098-47bc-8217-e93790243dfa",
  "schema": "f9e8d7c6-b5a4-3210-9876-543210fedcba",
  "schedule": {
    "type": "every_n_minutes",
    "minutes": 15
  },
  "directory": "/uploads",
  "file_regex": ".*\\.csv$"
}