Skip to main content

CreateExportSftpConfigInput

Input for createExportSftpConfig.

input CreateExportSftpConfigInput {
  host: String!
  port: Int!
  username: String!
  password: String!
  path: String!
  columns: [String!]
  timezone: String
  enabled: Boolean
}

Fields​

CreateExportSftpConfigInput.host ● String! non-null scalar​

SFTP server hostname.

CreateExportSftpConfigInput.port ● Int! non-null scalar​

SFTP server port.

CreateExportSftpConfigInput.username ● String! non-null scalar​

SFTP username.

CreateExportSftpConfigInput.password ● String! non-null scalar​

SFTP password. Stored encrypted; never returned.

CreateExportSftpConfigInput.path ● String! non-null scalar​

Target directory on the SFTP server.

CreateExportSftpConfigInput.columns ● [String!] list scalar​

Columns to include in the CSV. Omit to use the default column set.

CreateExportSftpConfigInput.timezone ● String scalar​

IANA timezone for date columns. Defaults to UTC.

CreateExportSftpConfigInput.enabled ● Boolean scalar​

Whether the scheduled export is active. Defaults to disabled.

Member Of​

createExportSftpConfig mutation