OpenIntegrations/docs/en/md/SFTP/Common-methods/Create-connection.mdx

---
sidebar_position: 1
description: Create Connection  and other functions to work with SFTP in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, SFTP]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Create Connection 
 Creates a new SFTP session



`Function CreateConnection(Val SSHSettings, Val Proxy = "") Export`

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | SSHSettings | - | Structure Of KeyAndValue | ✔ | Connection settings structure |
  | Proxy | - | Structure Of KeyAndValue | ✖ | Proxy settings structure, if necessary |

  
  Returns:  Arbitrary, Map of KeyAndValue - Create Connection

<br/>

:::tip
Get the connection configuration using the functions `GetSettingsLoginPassword`, `GetSettingsPrivateKey`, `GetSettingsViaAgent`
:::

:::caution
**NOCLI:** this method is not available in CLI version
:::
<br/>


```bsl title="1C:Enterprise/OneScript code example"
    Host = FunctionParameters["SSH_Host"];
    Port = FunctionParameters["SSH_Port"];

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

    If AuthorizationType = "By login and password" Then

        Login    = FunctionParameters["SSH_User"];
        Password = FunctionParameters["SSH_Password"];

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

    ElsIf AuthorizationType = "By key" Then

        Login      = FunctionParameters["SSH_User"];
        PrivateKey = "./ssh_key";
        PublicKey  = "./ssh_key.pub";

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

    Else

        Login        = FunctionParameters["SSH_User"];
        SFTPSettings = OPI_SFTP.GetSettingsViaAgent(Host, Port, Login);

    EndIf;

    If UseProxy Then

        ProxyType = FunctionParameters["Proxy_Type"]; // http, socks5, socks4

        ProxyAddress  = FunctionParameters["Proxy_IP"];
        ProxyPort     = FunctionParameters["Proxy_Port"];
        ProxyLogin    = FunctionParameters["Proxy_User"];
        ProxyPassword = FunctionParameters["Proxy_Password"];

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

    EndIf;

    Result = OPI_SFTP.CreateConnection(SFTPSettings, ProxySettings);
```
 



```json title="Result"
"AddIn.OPI_SSH.Main"
```