YAML for agents

YAML parameters for agents

Name	Type	Required	Description
agent `required`	String	Yes	Name of agent
target	Boolean	No	Default: false, Expose as target
disabled	Boolean	No	Disables tunnels in the agent
tunnels	Tunnel[]	No	Default: empty, tunnels in the agent

Tunnel parameters

Name	Type	Required	Description
name `required`	String	Yes	Name of the tunnel.
endpoint `required`	String	Yes	Target to which the tunnel binds. Port number or address (e.g., `80`, `localhost:22`).
type `required`	String	Yes	Type of tunnel. Available values: `HTTP`, `TCP`, `TLS`.
region	String	No	Region for the tunnel. Available values: `EU`, `US`.
whitelist	String[]	No	Array of IP addresses allowed to access the tunnel.
timeout	Integer	No	Timeout value in seconds.
http	Object	No	HTTP-specific configuration (only for HTTP tunnels).
tls	Object	No	TLS-specific configuration (only for TLS tunnels).

HTTP tunnel parameters

Name	Type	Required	Description
verify_certificate	Boolean	No	Whether to verify SSL certificates.
compression	Boolean	No	Enable HTTP compression.
http2	Boolean	No	Enable HTTP/2 support.
log_requests	Boolean	No	Enable request logging.
rewrite_host_header	String	No	Custom host header to rewrite.
whitelist_user_agents	String[]	No	Array of allowed user agent strings.
request_headers	Object	No	Custom request headers to add.
response_headers	Object	No	Custom response headers to set.
tls_ca	String	No	TLS CA certificate (encrypted).
circuit_breaker	Integer	No	Circuit breaker threshold value (0-100).

Auth parameters for HTTP tunnels

Name	Type	Required	Description
username	String	No	Basic authentication username for HTTP tunnel access.
password	String	No	Basic authentication password for HTTP tunnel access (encrypted).

TLS tunnel parameters

Name	Type	Required	Description
terminate_at	String	No	Where to terminate TLS. Available values: `REGION`, `AGENT`, `TARGET`.
private_key	String	No	Private key for TLS certificate (encrypted).
certificate	String	No	TLS certificate (encrypted).
ca_certificate	String	No	CA certificate for TLS (encrypted).

YAML example for agents

yaml
- agent: computer_name
  target: true
  tunnels:
  - name: web-app-http
    endpoint: localhost:8080
    whitelist:
    - 192.168.1.100
    - 10.0.0.50
    timeout: 60
    region: EU
    http:
      verify_certificate: true
      compression: true
      http2: true
      log_requests: true
      request_headers:
        X-Forwarded-For: client-ip
      whitelist_user_agents:
      - Mozilla/5.0
      - Chrome/91.0
      rewrite_host_header: myapp.example.com
      response_headers:
        X-Content-Type-Options: nosniff
      tls_ca: '!encrypted EMkJN/iT4KGk2ogMc+iQyjvK5woaXXsSgmXJjfsiNLTAYpllZ1+bIsKJ3+AH/QOKwRj0IUVKinVKWrj1Fg92IYjJgnDbJcyKVSgH0JyAle4xwOcQVoeYCQFjodkJxDsLJBunFO62YNtxDtuMnTAvJ2H+XDNUOP5KEppCpYd1Bd8zowwpD8ao/9VLinQiTb54Il+H4zrh828nJseaYZQDScb8lbmNGjz+5+LDcXGKH+BASZghvHEgJ7IQgx9Em0mHEY3GwPRhsRHyq7VMRTDWskhbo0ZtJ5oYk1aZ432nK9p9P7PVRnWgIdzn829KuodIULJytLvMX2HEGQ4JeZ0SY37yq7SXvFY82RbWZ4zGuGYNqehaEGtunqDZqms25Eq4ZFH1xgwV7w/YERfEKu6Nf0jPKKhe2Z7kjHVMWd9r1/yKy+vowJQ5/Q/zGMBJtw05aKT76Ffl98gCT1lWjbUwgv+JN3zhYQGP/f7p5zAIosMewm/1j1NrA26IArsGFX8/e90OojrQtJ68CP9JFd/C0ffszwnLsuvy9i9NDnE5n0+lQeG75HGTTvqidAp5Y6jjy+iYJEop/FEWVgKVU2AkMa6ba50Y+uZKRZapsCxkKwo1KBXeETA2H28o3ufsUwCP+e6uoMzp5foKsuu6q/57p9ZMfArA9UKQ1N2ZCBFVssEr4UY+aqspxMsuU7H3/re9hAfwDZsrxPdic+Jbp3QFJkO8y5rwK8k1/ylqD8kd0GKpALSOfxEL5JK9rjrnBPbamlffftQOo+c8stiJcvrzIFLuc6sIzj3fZ6PLu/um4vdKD3u1JIROWAOxmoFJ3lznoz4kY0W3LACjW5306orBkZn0IHwHBE9VW+SUqid2UhOKo/stIW3UqvEW6BCEAR9A0jNWGMzi+DmSpwgXdHWxz54Hdl6sT5TmzNh43BzJsTkTtoa86KIvqN38U3gvNAz4KRx1LCxypQPF12cPH7xO/bafsFaWNWq+8dGH73P7tTPtSsMHIgQEmugWT3uj4cu6qfYgnxyQ80NRs4MzltNZyfbmPzIeZpRBC/ueEDct1egkEyPT8asJZvn2DwwvGGtFFtr7wrIJumWuGPYKY+d79BvBu1+/UIDH6k+cAzHaRPAz2OX6F2QI2m0K1kD0FLbmAjpy4j1VsYdBxvPXHbkvvedoUrA/Q755OHjfBJjOuHdxourp/PXLmixYl54lkEX8+b7sST8FjaZoZom/u9lbYzDO458zfirM9dqWXNunQ1Rtk83i4AfjX12FGQP0ROTQAMrWdXTkBbDXBn3EASLETMe0Z6KB1CSIjLQfbXsXDef4uLA5TTvuy7SVP7ZiQ8jvn6YOI9TyA36eMuyUpEDqm38qRQJY0AGqIvHhw2Qqylyi/94cWGZ/OA1Vcb5TpQ6iUiUf64lR4JcIV13fHOz4+8YTgnlRLMs3ga9P+dqutbVrQzZ7cLdtXwm8NhbBGs7ARC1u5Hax6eJJHzUBuxYaNdYHmqdCWKmRA0cyl/6dneEUj11zRGjpDg9cQjyhXwa7hQTe4224w+rV2zYzT2tUAs0rrS0i9ASohVObbraVKBUnr2hbh2iP6l4X3T6rd+I5no9zVdTYsGy8b1GgPIx8/12szhS0tYw7cqeWk5gmr6jGHo4NqkG/yfAIDOYeys8TQYZyhhJvwJN+Gk5ML9jT7lrLF/jc0jzzqg8emxvBE9iDOdlfUtBgkZIW/UDX+sLxQXfes+B5sSASz0Zlj2uLMWd0ykO5hU6O+AjqJm4L2uPkzAXyEeTXec4CP3m9JnThQ8KJdD6cfepZ6CHBO098NnFdXpzqkRBnqPJbFCkimLQ2xCBFyvazZtelVennseLVif2Y7vsn6kbV9uppfMaMRsgvuFcZjkib9J6YZXpETUK9Ycrh/9bUGBiL779uTmpa2NAWnacLxyoKQejeAEBznr5m25eGEGtbY5qPY/ttOMb4UA5aEtJIjBtBML17E6i76hxZu+ybM6C2Ebn5l/Xolkui+9JS5HYAG4tHKgvJdgKFdf0t5M2IP83audP2T33iTiKgFfoX2MdHVa4uX875s1p0XawHmAudPcC8+R0M5w6J5I/EXtEmsbv9MDbaTSMcXDWQ0iqoOSZli50449SVNWs7vCeXu5hH2lNDABS+gfLSbZi+TNfuQ/SfyL26n4TBA2ns3m4rjnK/ojkr9URweB61/znDDLPkGJyfwxQsrLhSSpJduJqCU1Yn7L0Nonmt/4/qYX20Yna1JWfuRnT64jpnpkSnB4KyhjUmESuaeclVRPfKDcfwA4cxe9cAniGIeBHD72OB4suCXAA11ZJaQFWp+Y3l8t8PdaVycogPECvtx0tvLkK4WyWOUYP5rWk84pyRzk7T/zufK0ZwPxGtGpwNsxRS46Pp7JqAA8xxuVbSoxfx3HOIrz5n+r4ULLHCUFg6oMIeg7Beukqri2BXx47U5wYTM0PMulPvwDxe4r1p5f3nSJz1B55Jl2KG48mCC0SnHnwqDXwn434SM+4T4ZBVRl+5EXtp1NkN14i1CA5S4Vx+CYRHJfX68CgwlWBhR6LLda5Pygrp9vqWwjJhWeGf174VZS0rCbsoKpvKAh0=.Yf+86KDR3Zhw8Cq04+u6pQ=='
      circuit_breaker: 10
      auth:
        username: admin
        password: '!encrypted lrY4edMEUipT1h96vGYN7w==.nP7nPXCU/7jBUkuvRhM3Ig=='
  - name: ssh-access
    endpoint: localhost:22
    type: TCP
    whitelist:
    - 192.168.1.0/24
    - 10.0.0.0/8
    region: EU
  - name: smtp-tls
    endpoint: localhost:465
    type: TLS
    whitelist:
    - 192.168.1.0/24
    timeout: 60
    region: EU
    tls:
      private_key: '!encrypted lhwpnIJ/nFLPU58XCd937RIz5E5DUX/giyepNsl+FOKlKk+b112DHGxxsKp2IdTRoJb5cJJ7JbC1KD0QkiJvu0unB5e96U2kSVT1jlzjb+HkcvKHMIaG2iXai1JLqT1jTTfvRYjUzRpUQsrxLH92ooryMzLs+Rt7QllXwYulwUTsxNdtihdeSWecKhpiA2lMr0R6c6VefPIunCz0UJ0c+lqXYmlOif0aFrLd/dLe7DikppukKbbceF41IH/rH27XaottYg5G3qRfE+YVYErSL9Ldcda1ijuAZZHsQIO/Fa+CiS7EXqYsoxCGcffd8J76NNnM1rovoR071Nk8VesKKos/B6Zlk8ADxt7ux9mitaD0pGTrhgoGPKrZpYsrZ6JL9hQUtBKexzBqSsCD/P2FwNjhlmh6rAm15RxWWOMmzbLJX4XGUTWxAFzpW94q9VbjHDs+9N9p/td6fzD8RB6+WHbxRFys58mD9gzUaZDdMMVWn31VCppka8zArpL8UlAcqSmUc1n787toKOMXXw288Mkk3tyDVlRY8KUs5G5LghKjFlFigXv+nSBHThJ28vZ22j5rxbNle8LG1F/++iiMsyDH9ANuHlEJP1/LmP61xoDVS6ah2L+Zm9ctgYE2JftI9XTrmpWzz9CQTCIQZrgx0+hpkSmRx1m8gUU1nvbV3+d86hXRO448hpu3O4snREwhuDohVuYHd5ab5HbPsmso4SGC0VJXMx2mm/xyxAWwaZG3O9VDIWOY3/PQBrRWXIxlejP2yPJuBFz4YDjOzBY6zve1tYWNOCgzrRsTpevUK/IsVU5O3qhLMVzohclC2U6UDAwhwlPsx/XqFxw8U2zIxqXKm9hW0I6FocA0vH8RgLt7eRFAffhSvG31jMqdnE6fr/ltPt4Vg86gveLalhUFAUnjWutsN/uHm01LH5nC/Av2TQlVmNkARCjUyGvcMynYo49qbo6cMCb6LuHW+Tvuwwb/P5DGiHAIsbojVSf2HxaMmOwz7I9oOPfeAPRVidVpML/ylnxyy1n3j2PjUyKXpFTnNqDqePZ/VUtJ4YM4I2nRfFZ2Sa/MhaB+T6OENMe3moMnhmMIImn7ky56l7Jto5hnmVEZyItyCnmV4GDdMfWR4jRXqgajtKqiy8jYGIdL0YcaxRQo573UstqqM9nFKIW9RwgVacE9ENVCHxGLapaBuKqjkwb2R7edU/xQQbry6q+FXXtczlR2HpLHrf3UfQH80UN/h29c0IpLtCDLQGyZvTkF0Aq6e2lpWe/mSo8ORE6JnyKdJyDRk4b6ILUuhGZ4BF7qmiaQlCrD6qLiZ01NES8lHVr9taL8dkWA4y1qEi9vEwRyDin4eEAhMqWoAb5vSjkMvt+AJUHUzR/OZa5ORdh/N5e48IbKSzAFKHtGpLFF1tKsJAa53u79UpCF5Xl4mfgpVM0l7gB7xa36RYVrVFrh+Sl1Xo6iPcFE+4s68/qg7BFt1Qr6jZCiUR6PvAo3lqZmyG9reKf4yc8XRzS5v9h5sn0V9PPry4umS7OMnpjAkYkiU076laxMsSJugSxqNsJ+prt4pab/FAwWAZFXew7BGI5ZnksmRlSXv/aCFsdu0OKFTKF9qOs1/BVWPOD2qDVQlQus31PeiQU1GCY6PEhkpbj/+F2pf4Pxhf7W59TJooJp23pOBsrgUr1a49VX3T/AapEYIjoXa3ZyWDopF7pV5vwntdfW/3YEy6lTgydodPW1eXpS4bcjwFdxvuOvgPJLAiliwE7W/chwClZc5rSfwoGxUCfgOphGKkslCkwXBgFsDoGzZ64ECsW19QBMQf964qKdMy/m9q9vxNBc080txgIUE4eY3GhhB+TvQ+F5IjINqKhOeFDKTPN8y7jmMH63qP56eQJWtfQFHJttLHtnNvnZEuCYYh8JgrP1cYRYz8Y5PiLFCZm/kQFCkqpgtv4UKjWgaJsO6BevTjklZBb/U436ZN89lUMSBViEWCukFoDN0652lZjZAwp+h2h1hEdregcsKwEz8VLRsvQD38N+aUoNOV+46zmLDavpdUiVl7pSKK6CQ8fGX9ML7r4kCTSDk2HkJYwQOH0a8dVAkI5Vp681ngHLKO61F+fFA377uRXDZPkD4My7Gzj4G/WHS+epth5xwaxWgs7vLBjvg6WAfznczOpeanesvzZ2cGoD2bR6uSFT19r1uxiu6cgvQofTi7t2B1RAcydzXOprzMeWqyrSYtWHlJOIpDJEgVxIhUvE5CjboF9AYByDd9rCOwWR342I+x0kYSoF/Rw=.QYRJMV25xzICqUDqIGR1aQ=='
      certificate: '!encrypted +vkc5sM/+L/xzfBWLgIvCHhlP/tiprEw8h2NWdJUMa9kW4UOZzULnuk1JwrwheP3umrjYqB7aA6G1DGbeobvwTV5mtyQAt7aPTtAn+G/b81qjIQMUM040p+S2nmR4cVwLA99xq5ByNMk1+TyfZXE3hg7MG94LkC8eXWomLTQpLiVfcklZYmG/zeLR71/5mLinLVInGhEITqNoqsQ/ggRo7ZcjrpCXTXpGm4ySWHb4sC7aLBJ/I8qYx5GiO27oi4+Yut7uA/uNY72hTLi3f1o6TNBHX2tRBNAbbjBUBLAzpQhvc6IWQI/doXTHYZ3813GeW7CvvGtlMWOpbUsQDkjSPf9QlVD9DnITb73/G8JZPSJJkpLpu4d4D4Wt15lLItZ/iRztUDEpbBl8Fiita7bF4i0kdQ1Er1toQeiI84MWxZyUl7rlUSa/uA/G02HMbCaP+++P4lhbbiHMOvemxhtamxUmmaC+o+a6U1me4dkimjtTbHqrC+JlILJCcwMQMYqRl2ilXlHzldPyYUrv/0m75R93GBnu2ApDr7C1bpos/02ka5xipuBnf1z2V8M724SFXxVqf6ZfY61L7h/i82CnKvh0huYxTq47PkM1Bs4Kiqr/uBLhCFZZg+JoWmfxdCTNP4Gtw37owgHOq+vMkwL3t7gdRzhTEOqFD3cmb81jEX9qTUBTmV6tMIuAKs9a18FnKeXnH9F5E0VkmfvaGbvuIZnyIshOe3C2vTekjW0pQWB8X1hidhma+jIh5XrI+f+W0DlW866QXXNHBTBWuokCfo+/XLXsS/l3rkNeBxpuYpU7C7O1BS5nNFSXxp/4GYG03GugmaHUbs+jjiYb540llpaqqz9OrnEQ9HOOVCq6ChXyrY53lVzJXo4OEKxGzsKQP8hgSJvb77zC7Pj0OMGWh//ylln+kqL2kxIpgR+fxXZS+3NIVOCl4g8ZIXjW5NZWwJ9GHD9JBISjazohov4F+zgilfkZPNXbHcDGZp7Pk/6Sc2GYdibpH7DqOv0wHZNkKVc67xWfKFdB9AxF93ruXVUtf3Ms+FKMsizvy+yhsVqy3r0us5EIrjeCQQR3ycNW6ZyGSU+QXJ9TT+3nDgN70Q3NWGfPDc/LYR2H2a7lIfWfNUMWAirITe7mE//9mKpOj4rZuxvW+DEFC1K/TJqWtLSkC2H2D0Q5qlE95yDEAFc+h/ZzTCT+skGWJPLN1eKVu/vK2KQ0TyjMqIBh59lZu3XrBVv9fLUzQ4V+dJrlUFJtMqNPcqBjJgvJz+BAQqm5PiUzvFHKbx0q4xFFF+Pxc70gOgW7MyrRW1RcFf8DlFVrPoWTskvP2MetXBou1lrD+AEdo30UxChksIaam8+sl8WeNXe4jGmchyBjLKFAlFm+vNd0Cm7/SU4Ljwwk6nTIX4ax5sRYGDfOoEog7Zbm+9lV7IMUbIELHNvqMQJvjcxVhcfXEsWYBFeajjnST+ZJDmmLBXzOnvicQYrH/tAWrM8Q4wgAn4yA4tHNwD1o3g=.jauspS2BfA+STzWu2wgXQA=='
      ca_certificate: '!encrypted VUrxs424twTnr7AiVfDhZ4wb91JIWVuIm+0+rXrmMy9xQQKS4QGwwyuum9qQ2W+JctYraIXHcglV7Y+u2XPxoean0gDbXOvyNqxGkahe7F0tTOKMS5jwnJH5ZjXz1V9pKfqAlA+zsGG+kggSs5wz/aNGYIyFAXwh+b7iw2u1LMsu0mG0OZ+vwky0DMmOgwimJQycLRyZhVRllxSzO7ig0d/Pa3RPMZ7gvOY6acM3hBEQCYgsLg+eufwJGYMJ/OYZaTxkxuU4pvzexGJmzZjkwChiRBf65WgOSJnbCzrhXDfmzvxiDgWOMOV3FQ2hbqY3zdodZgE5/k77VE92uaHUnbqHE75ynhzCJxH+Snq5MvdkgFDU3xyghz9t9CT5n3iTzKW98Xf4emEXCW7LIeXDOUQUclq6AOyacg+bRTJ6VG4h+/AHiu20sgPEyEspIba0Gczct8KrWJ5pNpQCMABrfHC95dYx86YB8EW2pcOn4iUGAo52gJnl01bAltVjDdcTrHMx4XN1H8LuTTHZ6hV9URio2+pBB92QStj/u79jRm8r1UlU7umQg6t4GiJvTtIw+V1Z1jWy1jhgWT1HikZ6Lj1Jyho2dsRPRffs43d3fUIL24I/OYsMS575to2aFO85POWxiRPIAQKlPNN6XEayeMAdMzDt2Y3T0S5c83HZeDTvg1jStLcm7ItLAKqD5Uifu4/Tr7VZ0FeBda8t0HCHr2rKuaOsJL0sAhygQq27exuGE7XcbMm4zkzN7zNdABwsEDZlOnr2HpqiasvjMyqTwzg1HIuAZSAlCoKfzzC4dHn316UEktRZtlhTD6qD0Ec8RgMyYG1kNjykpbSbJU6ZWTaO211HwiS/XPzkxjnULaixoOXNQuqw/VZXFVlp9WkDtgS4HC2SzfPSPKzGt68xcWD7JyeZt7N+KoTTXT1p3DfDFdmbUBSZqLmUyCyPnB+wqkO03zlaM1i5b2R6Et5rXiE+wW+Bo/T5FRf+dQxFX+dTdO6FxV/XRwV3wuPlrX0ql7FlA4uAQlEN0hbzGFRngdyyPFFDU/uxJ2ZeKqsVf3iteeWdlrgh7pomMUXheXQMTQutkXtT3P0xlUcU8n1HdJ/dnJ5mP9a/IsNKGmTE09g+HCyuDAhGOHQLFAdVu/0Jsf5za8bQR4ETtFXzaS/aWasAnpL5cjqu2Ls+tYctON+/rjY+qVVrAGduUB+lnVZZuY8hQYqASM0XsaoN7ZjV+8UfWnIzVkTVQrgXUUbKgcu6QdM261I0gGjZMgqIkM1qlj0fqgmrX73RpByKxop1ETCrWc+1rO6HZyRAc3WGBoX1KdLWH98xvusbBNNS6ZSeX3iAhRKs+EHnha+M9d0SJX/EUslsk9359YI8RmklJRU/Z0CjyFUYwiJn3ICIWG9Th1DURUbbsjvSbPgR3FabsTPlCUHVDFniFxN8FJNMQE0AT55QE+o4GpNs+vBfTfbrkcT7aUKUPIOeIkqLzgOfKwlKWrAKX43vtNCMx4gU9i/zrSs/JiI81pXJGoALwCPaaPWUL8x8N8w5uCg1Xsw0BYLMbzZeEkuNExp7/I0DxYcutSaHvrhQ0jw1Th11YsIKnQffYmmxFcHprq/RJSV/m0IUJsObhNZDwpzNNDSw4is2cOTN3XytkyGF0bmH4kKIqyntq0IH7eeWoaA8X7NMImyQSAyJ7dnjGB2QwMwz0+FdhQ8zwHAVjuVLEWGeDshbyqBBvSfpsobVE8IRf2gs5VqM1eNvRYwzYTuS/qLHQo/z7ACgqJtNRY9op7oGEhSJil9ENjUnINkn4yblHRQDNICCahRz9RQFXCbbzb/QFQdXrG94NvRZUoRGOB3HrbSsqFYq1I5AzRbdferNUFHD3lMeeDbLFYRGpxEOCo02oPq8N1dbYs8yd6EqH3N7V079HaFYDz4UQlyLsL0L5TgycMw9wnVgojGQ+5ciYHxktz/OaQ+cpirbdR5G8wMVfB15m5mc0TN+eX3YekowpwYjHI0A7183NLdKxd8yRuFJtA2/aJSyLpAE4RVsZaNxizUxZytfYW+b7cRERho3w9oyh3KgS0tLuGSVNAnznhI434rBB/z9rS7h7OFoWXeJ9CMHk8e/uYch8w4NJ3goktjMnRGii7cvLD7PvHEICCOE1Z7K4mzahRG0c58jd5SYnRiuo8hj0qu4FOw2N+mxmxonZfKXED3Yh6w2roOKQ/O6OKKIJL7SlIejtPpJcTEWNOJKyA1t7oDSuXnY4y2ee08Q79vfQnvGLYBqkrGaYytt8f9hv0sdwbU6/dbh37AHcS+MWT8gg0tW/7mTO4I+NMEsN6TgclWYmEpERxbPmbQtQL0swtnbe3ZPuZKdVrg7i2WLU/ktETI7EEHPJvWOKKtSCWsgV6tgiBtZwRhSp4f3Keqa9cF5nYWvfkPnMwN2lqhYQWkH6zcmMa08mH3S0dNnk8P/ZUzQMmVvgtaaglpToNhxKoCoK5quOhuBHykNQT8ZeqYyfCJDr0vtNKBOHczDR4fqKSwTwZElgg3z2d66loHRg6pDbB3NDIxlt+9r3NvCX01JVVvQqZynZZyoBDegk9MG07Kcj5VioOEhQkirdrE=.6BEpVh9BPf7S+KAut0QNwg=='
      terminate_at: AGENT

Last modified on Jan 21, 2026

YAML for sandboxes YAML for domains