SFTP transport reference

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 3 methods. Search the docs for an exact method name, or use this index:

transport.sftpImport()
transport.sftpExport()
transport.sftpCommands()

`transport.sftpImport()`

Streams a remote path into Storage, then finalizes it using storage.* namespace/ACL rules. Uses transport Secret formats and optional host-key pinning. execution.log carries details.source and details.error (code/retryable/resource/reference/statusCode); runtimeError may expose matching metadata.

Signature

static sftpImport(
      path: string,
      storage: SFTPImportStorage,
      secretNameOrId: string,
    ): Promise<{ session: StorageUploadSession; entry: StorageEntryView }>;

Example

const imported = await transport.sftpImport('/incoming/daily.csv', {
  name: 'daily.csv', parentStorageEntryId: folderId, computeStats: 'sync',
}, 'SFTP_PRODUCTION');

`transport.sftpExport()`

Streams Storage to a remote path using storage.* namespace/ACL rules. Automatic execution.log includes details.source, details.error and telemetry.transfer.

Signature

static sftpExport(
      path: string,
      storage: SFTPExportStorage,
      secretNameOrId: string,
    ): Promise<void>;

Example

await transport.sftpExport('/outgoing/daily.csv', { storageEntryId }, 'SFTP_PRODUCTION');

`transport.sftpCommands()`

Runs allowed file commands in one leased SFTP session, without a remote shell. With readOnly: true, permits only pwd, ls, stat, lstat, cat, readlink, readat, and glob. The full batch is validated before dispatch; any mutating command requires readOnly: false. Automatic execution.log identifies the call in details.source. Inspect command errors even when batch HTTP succeeds.

Signature

static sftpCommands(
      commands: any[],
      secretNameOrId: string,
    ): Promise<any>;

Build applications

Low-code runtime

Low-code reference

SFTP transport reference

`transport.sftpImport()`

Signature

Example

`transport.sftpExport()`

Signature

Example

`transport.sftpCommands()`

Signature

​transport.sftpImport()

​Signature

​Example

​transport.sftpExport()

​Signature

​Example

​transport.sftpCommands()

​Signature

`transport.sftpImport()`

Signature

Example

`transport.sftpExport()`

Signature

Example

`transport.sftpCommands()`

Signature