https://embedded-workflow-builder.netlify.app/assets/js/dfa647f2.061093ba.js

1"use strict";(self.webpackChunkembedded_workflow_builder_docs=self.webpackChunkembedded_workflow_builder_docs||[]).push([["8176"],{68788(e,n,s){s.r(n),s.d(n,{metadata:()=>t,default:()=>a,frontMatter:()=>d,contentTitle:()=>l,toc:()=>c,assets:()=>h});var t=JSON.parse('{"id":"connectors/sftp","title":"SFTP Connector","description":"Read, write, move and delete files on an SFTP server","source":"@site/docs/connectors/sftp.md","sourceDirName":"connectors","slug":"/connectors/sftp","permalink":"/connectors/sftp","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"SFTP Connector","sidebar_label":"SFTP","description":"Read, write, move and delete files on an SFTP server"},"sidebar":"docs","previous":{"title":"ServiceTitan","permalink":"/connectors/servicetitan"},"next":{"title":"ShipBob","permalink":"/connectors/shipbob"}}'),r=s(74848),i=s(28453);let d={title:"SFTP Connector",sidebar_label:"SFTP",description:"Read, write, move and delete files on an SFTP server"},l,h={},c=[{value:"Connections",id:"connections",level:2},{value:"Basic Authentication",id:"basic",level:3},{value:"Prerequisites",id:"prerequisites",level:4},{value:"Configure the Connection",id:"configure-the-connection",level:4},{value:"Advanced Settings (Optional)",id:"advanced-settings-optional",level:4},{value:"Private Key",id:"privatekey",level:3},{value:"Prerequisites",id:"prerequisites-1",level:4},{value:"Setup Steps",id:"setup-steps",level:4},{value:"Configure the Connection",id:"configure-the-connection-1",level:4},{value:"Advanced Settings (Optional)",id:"advanced-settings-optional-1",level:4},{value:"Triggers",id:"triggers",level:2},{value:"New or Modified Files",id:"newormodifiedfiles",level:3},{value:"Actions",id:"actions",level:2},{value:"Append File",id:"appendfile",level:3},{value:"Create Directory",id:"createdirectory",level:3},{value:"Delete File",id:"deletefile",level:3},{value:"Fast Get",id:"fastget",level:3},{value:"List Directory",id:"listdirectory",level:3},{value:"Move File",id:"movefile",level:3},{value:"Read File",id:"readfile",level:3},{value:"Stat File",id:"statfile",level:3},{value:"Write File",id:"writefile",level:3}];function o(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.img,{alt:"SFTP",src:s(20522).A+"#connector-icon",width:"32",height:"32"}),"\n",(0,r.jsx)(n.a,{href:"https://www.ssh.com/academy/ssh/sftp-ssh-file-transfer-protocol",children:"SFTP (SSH File Transfer Protocol)"})," is a secure file transfer protocol that operates over SSH.\nThe SFTP component allows uploading, downloading, moving, and deleting files on an SFTP server."]}),"\n",(0,r.jsx)(n.h2,{id:"connections",children:"Connections"}),"\n",(0,r.jsx)(n.h3,{id:"basic",children:"Basic Authentication"}),"\n",(0,r.jsx)(n.p,{children:"Authenticate using username and password"}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.strong,{children:"Basic Authentication"})," connection is used to connect to SFTP servers that support username / password login."]}),"\n",(0,r.jsx)(n.h4,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"An SFTP server with username/password authentication enabled"}),"\n",(0,r.jsx)(n.li,{children:"Valid credentials (username and password)"}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"configure-the-connection",children:"Configure the Connection"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Username"}),": Enter the SFTP account username"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Password"}),": Enter the SFTP account password"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Enter the SFTP server hostname or IP address"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Port"}),": Enter the SFTP server port (default: 22)"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"advanced-settings-optional",children:"Advanced Settings (Optional)"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Timeout"}),": Connection timeout in milliseconds (default: 3000)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Enable Unsecure Server Host Key Algorithms"}),": Enable deprecated host key algorithms for legacy servers"]}

1),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Enable Unsecure Ciphers"}),": Enable CBC ciphers for legacy servers"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom Server Host Key Algorithms"}),": Comma-separated list of custom host key algorithms (overrides defaults)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom Ciphers"}),": Comma-separated list of custom ciphers (overrides defaults)"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Consult the SFTP server administrator to determine which login method the server supports."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Password"}),(0,r.jsx)(n.td,{children:"The password for SFTP authentication."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Username"}),(0,r.jsx)(n.td,{children:"The username for SFTP authentication."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Host"}),(0,r.jsx)(n.td,{children:"The address of the SFTP server. This should be either an IP address or hostname."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Port"}),(0,r.jsx)(n.td,{children:"The port of the SFTP server."}),(0,r.jsx)(n.td,{children:"22"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Timeout"}),(0,r.jsx)(n.td,{children:"How long the client will await a request."}),(0,r.jsx)(n.td,{children:"3000"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Enable Unsecure Server Host Key Algorithms"}),(0,r.jsx)(n.td,{children:"When true, unsecure server host key algorithms will be added to the connection."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Enable Unsecure Ciphers"}),(0,r.jsx)(n.td,{children:"When true, CBC ciphers will be added to the connection."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom Server Host Key Algorithms"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom Ciphers"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom KEX Algorithms"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom key exchange algorithms. Algorithm order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"privatekey",children:"Private Key"}),"\n",(0,r.jsx)(n.p,{children:"Authenticate using SSH private key"}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.strong,{children:"Private Key"})," connection allows access to an SFTP server via SSH ",(0,r.jsx)(n.a,{href:"https://www.ssh.com/academy/ssh/public-key-authentication",children:"public/private key authentication"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"prerequisites-1",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"An SFTP server with public key authentication enabled"}),"\n",(0,r.jsx)(n.li,{children:"A generated public/private SSH key pair"}),"\n",(0,r.jsx)(n.li,{children:"The public key must be stored on the SFTP server"}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"setup-steps",children:"Setup Steps"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsx)(n.li,{children:"Generate a public/private SSH key pair if not already available"}),"\n",(0,r.jsxs)(n.li,{children:["Copy the public key to the SFTP server (usually to ",(0,r.jsx)(n.code,{children:"~/.ssh/authorized_keys"}),")"]}),"\n",(0,r.jsx)(n.li,{children:"Verify the key is properly configured with the SFTP server administrator"}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"configure-the-connection-1",children:"Configure the Connection"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Username"}),": Enter the SFTP account username"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Private Key"}),": Enter the complete private key (including headers and footers)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Key Passphrase"}),": Enter the passphrase for the private key (if applicable)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Password"}),": Enter the password if the server requires both private key and password authentication (uncommon)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Host"}),": Enter the SFTP server hostname or IP address"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Port"}),": Enter the SFTP server port (default: 22)"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"advanced-settings-optional-1",children:"Advanced Settings (Optional)"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Timeout"}),": Connection timeout in milliseconds (default: 3000)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Enable Unsecure Server Host Key Algorithms"}),": Enable deprecated host key algorithms for legacy servers"]}

1),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Enable Unsecure Ciphers"}),": Enable CBC ciphers for legacy servers"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom Server Host Key Algorithms"}),": Comma-separated list of custom host key algorithms (overrides defaults)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom Ciphers"}),": Comma-separated list of custom ciphers (overrides defaults)"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Authentication is performed using the username and corresponding private key."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Private Key"}),(0,r.jsx)(n.td,{children:"The SSH private key for authentication."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Key Passphrase"}),(0,r.jsx)(n.td,{children:"The passphrase for the private key. Leave blank if none."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Password"}),(0,r.jsx)(n.td,{children:"Though uncommon, some SFTP servers that use private keys may also require a password. Leave blank if none."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Username"}),(0,r.jsx)(n.td,{children:"The username for SFTP authentication."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Host"}),(0,r.jsx)(n.td,{children:"The address of the SFTP server. This should be either an IP address or hostname."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Port"}),(0,r.jsx)(n.td,{children:"The port of the SFTP server."}),(0,r.jsx)(n.td,{children:"22"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Timeout"}),(0,r.jsx)(n.td,{children:"How long the client will await a request."}),(0,r.jsx)(n.td,{children:"3000"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Enable Unsecure Server Host Key Algorithms"}),(0,r.jsx)(n.td,{children:"When true, unsecure server host key algorithms will be added to the connection."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Enable Unsecure Ciphers"}),(0,r.jsx)(n.td,{children:"When true, CBC ciphers will be added to the connection."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom Server Host Key Algorithms"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom Ciphers"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Custom KEX Algorithms"}),(0,r.jsx)(n.td,{children:"A comma-separated list of custom key exchange algorithms. Algorithm order matters. Advanced setting."}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"triggers",children:"Triggers"}),"\n",(0,r.jsx)(n.h3,{id:"newormodifiedfiles",children:"New or Modified Files"}),"\n",(0,r.jsx)(n.p,{children:"Checks for new and modified files in a directory on an SFTP server on a configured schedule."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"The path of the directory on the SFTP server to list files from."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Pattern"}),(0,r.jsx)(n.td,{children:"The glob-style pattern for filtering files (e.g., *.txt)."}),(0,r.jsx)(n.td,{children:"*"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Include Subdirectories"}),(0,r.jsx)(n.td,{children:"When true, recursively monitors files in all subdirectories. When false, only monitors files in the specified directory."}),(0,r.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"actions",children:"Actions"}),"\n",(0,r.jsx)(n.h3,{id:"appendfile",children:"Append File"}),"\n",(0,r.jsx)(n.p,{children:"Append data to an existing file on a SFTP server."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"The path on the SFTP server where data will be appended."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Data"}),(0,r.jsx)(n.td,{children:"The text or data to append to the file."}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"createdirectory",children:"Create Directory"}),"\n",(0,r.jsx)(n.p,{children:"Create a new directory. When Include Subfolders is enabled, recursively creates any missing directories in the path."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"The path of the directory on the SFTP server to list files from."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Include Subfolders"}),(0,r.jsx)(n.td,{children:"When true, recursively creates any missing directories in the path."}),(0,r.jsx)(n.td,{children:"true"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"deletefile",children:"Delete File"}),"\n",(0,r.jsx)(n.p,{children:"Delete a file from a SFTP server"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"Path of file to delete"}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"fastget",children:"Fast Get"}),"\n",(0,r.jsx)(n.p,{children:"Read a file from SFTP"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"Path of file on SFTP server to read data from"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Return Buffer"}),(0,r.jsx)(n.td,{children:"When true, treats the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8."}),(0,r.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"listdirectory",children:"List Directory"}),"\n",(0,r.jsx)(n.p,{children:"List files and directories in a directory on an SFTP server. Optionally list files in subdirectories."}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"The path of the directory on the SFTP server to list files from."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Pattern"}),(0,r.jsx)(n.td,{children:"The glob-style pattern for filtering files (e.g., *.txt)."}),(0,r.jsx)(n.td,{children:"*"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Include Subdirectories"}),(0,r.jsx)(n.td,{children:"When true, recursively monitors files in all subdirectories. When false, only monitors files in the specified directory."}),(0,r.jsx)(n.td,{children:"false"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Include Directories"}),(0,r.jsx)(n.td,{children:"When true, lists directories in addition to files. When false, only lists files."}),(0,r.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"movefile",children:"Move File"}),"\n",(0,r.jsx)(n.p,{children:"Move a file on an SFTP server"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Source Path"}),(0,r.jsx)(n.td,{children:"Path of file to move"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Destination Path"}),(0,r.jsx)(n.td,{children:"Path of file to move"}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"readfile",children:"Read File"}),"\n",(0,r.jsx)(n.p,{children:"Read a file from SFTP"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"Path of file on SFTP server to read data from"}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Return Buffer"}),(0,r.jsx)(n.td,{children:"When true, treats the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8."}),(0,r.jsx)(n.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"statfile",children:"Stat File"}),"\n",(0,r.jsx)(n.p,{children:"Pull statistics about a file"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"Path of file on SFTP server to read data from"}),(0,r.jsx)(n.td,{})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"writefile",children:"Write File"}),"\n",(0,r.jsx)(n.p,{children:"Write a file to SFTP"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Input"}),(0,r.jsx)(n.th,{children:"Comments"}),(0,r.jsx)(n.th,{children:"Default"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Connection"}),(0,r.jsx)(n.td,{children:"The SFTP connection to use."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Path"}),(0,r.jsx)(n.td,{children:"The path to the file on the SFTP server."}),(0,r.jsx)(n.td,{})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"Data"}),(0,r.jsx)(n.td,{children:"The text or data to write into the file."}),(0,r.jsx)(n.td,{})]})]})]})]})}function a(e={}){let{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},20522(e,n,s){s.d(n,{A:()=>t});let t="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAAD60lEQVRYhc1XbWhbZRQ+SWqtuM2tQ0H9M/yxSdY29+YmbR11oaJMkNX54+ocSZvc+96PdM26dnO6HyEVxA/wC4ZTp86hoFVhIlNxOvHHmILDb1BkP8WvISpU8KMmj5z3JvXGJk22JcMDT97De84958lzz32TS/Q/tUADtNMQ8NCIYCHYPg5hvZOu3rKawnr3Inj7nV6iJNFIrWZVK3jfaN1ta0g1PyLN+o008TNp4lcffiFNzFFUfEm923qrrmuq/lLKJgodclWN++iaaZDmzFPMxSJoTpEGdoA0+ysK62Ea1C+idSPLKawvWxJEDYjqekiufWNPUv8EN/iLNLtUE1Hrb4plmcwfpIofS

1BXfL4HvKCpOk2q8S+rWK7xmtZTQywQio49Tfw4UteZJs1EXUaso1ail0iLV3HmpqpK+p0rtOgo80RQBDyXSmEhD/ClVZXX9vc6UQCBWXv1+7F/fn/MfteZlTVb3bAkEojaoz6gU9HxVgBQBipjeyvsRUxKsSYBrnxWBqIWOqIUrb9yDUNxFqN/F5ZvuwLJrc7gkMYnu4Sms2DiJYMzBZTfsRgeTYXKtIBCMO6D1aTz64jHMvn0SKxKT2PngSzj83seIj96LVP4ZfH7qGww7DyGVP4jZox9i5sARBGJOiwjEHFBvBtsfeAHPv/EB1mzei7sPvI43T3yBnltn0NXv4rkj74Ouuh137juMg6+dwOzRk+jasB2kWudOIMBDpQpkZg7h+CencNPkPux+5BVs2bVfzsGq4Z146tXjoLVJTD/8Mu4/9BZWbtwhZ2JBhXMioHkELr1+F9beki83ncKFcVcOXDDuYvV1U/Lb8u3pUkxQT6Z1t4Aq4EnvSXuFFRMBnnhZvBxjXxEIMmmem5Y+BZqnhJyHyrNf63yodQacMYEIH8UTzZ6EzUESmGhwECUWfg33lxX4XV64BIIxu8RolCdrcU2u7e9VZRVWvaltNJADDeSKNJArlf3aUHgenPpxD6VyLVBfcmtVr7qmpG8mZSxPSuouUkb31kRkbM/6TdZPDPbr5skaY3nqS2+mJi3QbOKEY33NaDa/+dq6HpL3qQLNvsAnmyyyYWRkuSmsbxnsVzXgXL7GX6Oh7A0sHA53Dg4Odg8NDa2KRCIrTdM8Nj4+DoZpmu/wHsc4h3OpRRbgD13XQ4ZhfOq6Ljcr2raNbDZbsiyryGCf9zjGOZlM5rNEIlGZ9Na8RxiGMW3b9rO2bT9mWdbT2Wx2rqKA67pzvMcxzuFcapcVCt7f8FQqZQghTgshfmTfH2uL6boeKhQKHRXwXjKZvJhRbr4Q49y2EamYv8l5aUi17Xy8rLbX/gEtgBzzj02YAQAAAABJRU5ErkJggg=="},28453(e,n,s){s.d(n,{R:()=>d,x:()=>l});var t=s(96540);let r={},i=t.createContext(r);function d(e){let n=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);