Adds a new connection to an existing device

Published on Jul 21, 2025

1 minute(s) read

Post

/api/v1/devices/{deviceId}/connections

Security

HTTP

Type bearer

Path parameters

deviceId

integerRequired

The ID of the device to which the new connection will be added

Body parameters

The connection endpoint attributes for the new connection

Expand All

object

applicationProtocol

string

ExampleSSH/RDP/HTTP/HTTPS/VNC/TELNET/TCP

attributes

object

enableFileTransfer

string

Exampletrue/false

enableWallpaper

string

Exampletrue/false

not_send_proxy_headers

boolean

password

string

paths

object

Example{ "api_v1": "/api/v1/path/*" }

privatekey

string

request

object

header_rewrite

object

rules

Array of object (HeaderRewrite)

object

find

string

header_name

string

paths

Array of string

string

replace

string

replace_all

boolean

headers

object

add

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

append

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

remove

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

rename

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

replace

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

response

object

body_rewrite

object

apply_default_rules

boolean

content_types

Array of string

string

rules

Array of object (ResponseBodyRewrite)

object

find

string

paths

Array of string

string

replace

string

replace_all

boolean

header_rewrite

object

apply_default_rules

boolean

rules

Array of object (HeaderRewrite)

object

find

string

header_name

string

paths

Array of string

string

replace

string

replace_all

boolean

headers

object

add

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

append

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

remove

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

rename

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

replace

Array of object (CustomHeader)

object

name

string

paths

Array of string

string

value

string

username

string

label

string

networkProtocol

string

ExampleTCP

path

string

port

integer

ports

object

portRanges

object

end

string

start

string

protocol

Array of string

string

subdomain

string

Responses

200

OK

Expand All

object

authorization

boolean

data

object

error_code

integer

error_message

string

error_status

boolean

Examplefalse

401

Unauthorized

object

error_code

integer

error_message

string

error_status

boolean

403

Forbidden

object

error_code

integer

error_message

string

error_status

boolean

404

Not Found

object

error_code

integer

error_message

string

error_status

boolean

500

Internal Server Error

object

error_code

integer

error_message

string

error_status

boolean

Was this article helpful?