Search…
Connections

Create a Connection

On Demand Connections

To create a connection from one device to another which will reconnect on demand, you can use the Desktop Application or the CLI tool. This type of connection is Peer to Peer by default with a Proxy Failover.
post
https://api.remot3.it
/apv/v27/device/connect
Create a Proxy Connection
For http and https remote.it Services, the returned value for "proxy" will be a single string similar to the following. It does not need an explicit port value to be used. These are "reverse proxies". Reverse proxies are always public, which is why the randomized URL is generated at the time of creating the connection.
1
"proxy": "https://xprbjalo.p18.rt3.io"
Copied!
For all other types of remote.it Services, the returned value for "proxy" will include a hostname and a port value separated by a colon, as shown below. These are "port proxies".
1
"proxy": "http:\/\/proxy18.rt3.io:38575"
Copied!

Proxy Connection Modes

The following options apply only to "port proxies", namely all Service types except the http and https Service types, which use "reverse proxies". Reverse proxies are always public which is why the randomized URL is created.

Public

By setting the "hostip" parameter to 0.0.0.0, anyone who has the connection URL and port can connect to it until the connection expires or is closed using the API described at Terminating a proxy connection to a device. If you use the Public connection mode, make sure that your resources are properly password protected.

IP Restricted

By setting the "hostip" parameter to the client's public IP address, IP restriction is enabled. Only connections coming from that public IP address will be allowed. Any other incoming connection will be blocked.

IP Latching

By setting the "hostip" parameter to 255.255.255.255, whoever uses the connection URL and port first will "latch" the connection, blocking all other connection attempts regardless of where they originated.
The value returned for "connectionid" can be used with the /device/connect/stop API endpoint to terminate the proxy connection to your target when you are done using it.
Note Some response values are omitted from the example above because they are only used in very specific circumstances.

Terminating Connection

Terminating an On Demand Connection

To stop an on demand connection from one device to another, you can use the Desktop Application or the CLI tool. This type of connection is Peer to Peer by default with a Proxy Failover.
post
https://api.remote.it
/apv/v27/device/connect/stop
Terminate a Proxy Connection
Note Some response values are omitted from the example above because they are only used in very specific circumstances.
Last modified 2mo ago