Skip to main content

Upload file

Uploads a file from disk or binary data to the server

Function UploadFile(Val Connection, Val File, Val Path) Export

ParameterCLI optionTypeRequiredDescription
Connection--connArbitrary✔Existing connection or connection configuration
File--fileString, BinaryData✔File on disk or file data
Path--pathString✔Path to save file on server

Returns: Map Of KeyAndValue - Processing result


tip

Parameters with Binary data type can also accept file paths on disk and URLs


1C:Enterprise/OneScript code example
    ImagePath = "C:\pic.png";

    ImageDD = New BinaryData(Image);

    Host = "172.33.0.13";
    Port = "2222";

    UseProxy          = True;
    ProxySettings     = Undefined;
    AuthorizationType = "By login and password";

    If AuthorizationType = "By login and password" Then

        Login    = "bayselonarrend";
        Password = "12we...";

        SFTPSettings = OPI_SFTP.GetSettingsLoginPassword(Host, Port, Login, Password);

    ElsIf AuthorizationType = "By key" Then

        Login      = "bayselonarrend";
        PrivateKey = "./ssh_key";
        PublicKey  = "./ssh_key.pub";

        SFTPSettings = OPI_SFTP.GetSettingsPrivateKey(Host, Port, Login, PrivateKey, PublicKey);

    Else

        Login        = "bayselonarrend";
        SFTPSettings = OPI_SFTP.GetSettingsViaAgent(Host, Port, Login);

    EndIf;

    If UseProxy Then

        ProxyType = "http"; // http, socks5, socks4

        ProxyAddress  = "127.0.0.1";
        ProxyPort     = "8071";
        ProxyLogin    = "proxyuser";
        ProxyPassword = "12we...";

        ProxySettings = OPI_SFTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);

    EndIf;

    Connection = OPI_SFTP.CreateConnection(SFTPSettings, ProxySettings);

    If OPI_SFTP.IsConnector(Connection) Then

        Result  = OPI_SFTP.UploadFile(Connection, Image, "pic_from_disk.png");
        Result2 = OPI_SFTP.UploadFile(Connection, ImageDD, "files_folder/pic_from_binary.png");

    Else
        Result = Connection; // Error of connection
    EndIf;
    # JSON data can also be passed as a path to a .json file
    
    oint sftp UploadFile \
     --conn "{'proxy':{'login':'proxyuser','password':'***','port':'8071','proxy_type':'http','server':'127.0.0.1'},'set':{'auth_type':'private_key','host':'172.33.0.13','key_path':'***','passphrase':null,'password':null,'port':'2222','pub_path':'/tmp/44qy1d4j.s1l.tmp','username':'bayselonarrend'}}" \
     --file "/tmp/z2gjch3q.que" \
     --path "files_folder/pic_from_binary.png"
Result
{
 "bytes": 2114023,
 "result": true,
 "close_connection": {
  "result": true
 }
}