# HALBs

## List

> Retrieve a list of the HALB Virtual Server settings.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/HALB":{"get":{"tags":["0-Infrastructure/HALBs//0-Basic Operations"],"summary":"List","description":"Retrieve a list of the HALB Virtual Server settings.","operationId":"f1a8ac25-3fe8-4275-8d18-9857f7df49a0","parameters":[{"name":"Name","in":"query","description":"The name of te HALB Virtual Server","schema":{"type":"string"}},{"name":"SiteId","in":"query","description":"The site ID from where to retrieve the HALB Virtual Server Settings (optional)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HALBSettings"}}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"HALBSettings":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Appliance name.</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">The site ID of this HALB Virtual Server.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Appliance description.</para>","nullable":true},"publicAddress":{"type":"string","description":"<para type=\"description\">The Public Address of the HALB.</para>","nullable":true},"enableGatewayPayload":{"type":"boolean","description":"<para type=\"description\">Whether the Gateway payload is enabled or not.</para>"},"enableSSLPayload":{"type":"boolean","description":"<para type=\"description\">Whether the SSL payload is enabled or not.</para>"},"enableHALBInstance":{"type":"boolean","description":"<para type=\"description\">Whether the HALB instance is enabled or not.</para>"},"enableDeviceManagement":{"type":"boolean","description":"<para type=\"description\">Whether the Device Management is enabled or not.</para>"},"ipVersion":{"$ref":"#/components/schemas/IPVersion"},"virtualIPV4":{"type":"string","description":"<para type=\"description\">Virtual IP Version 4</para>","nullable":true},"subNetMask":{"type":"string","description":"<para type=\"description\">SubNet Mask</para>","nullable":true},"virtualIPV6":{"type":"string","description":"<para type=\"description\">Virtual IP Version 6</para>","nullable":true},"prefixIPV6":{"type":"integer","description":"<para type=\"description\">Prefix for IP Version 6</para>","format":"int32"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/HALBDevice"},"description":"<para type=\"description\">A collection of HALB Devices</para>","nullable":true},"enableUDPTunneling":{"type":"boolean","description":"<para type=\"description\">Whether RDP UDP tunneling is enabled or not.</para>"},"maxTCPConnections":{"type":"integer","description":"<para type=\"description\">Maximum number of TCP connections.</para>","format":"int32"},"algorithm":{"$ref":"#/components/schemas/LoadBalancingAlgorithm"},"clientIdleTimeout":{"type":"integer","description":"<para type=\"description\">Client inactivity timeout</para>","format":"int32"},"gatewayConnectionTimeout":{"type":"integer","description":"<para type=\"description\">Gateway connection timeout</para>","format":"int32"},"clientQueueTimeout":{"type":"integer","description":"<para type=\"description\">Client connection queue timeout</para>","format":"int32"},"gatewayIdleTimeout":{"type":"integer","description":"<para type=\"description\">Gateway inactivity timeout</para>","format":"int32"},"sessionsRate":{"type":"integer","description":"<para type=\"description\">Amount of TCP connections per second</para>","format":"int32"},"gatewayHealthCheckInterval":{"type":"integer","description":"<para type=\"description\">Gateways health check intervals</para>","format":"int32"},"virtualRouterID":{"type":"integer","description":"<para type=\"description\">VRRP virtual router ID</para>\r\n<para type=\"description\">Value between 0 and 255 unique per site. Value should be randomized to increase probability that it's also unique between farms.</para>","format":"int32"},"vrrpBroadcastInterval":{"type":"integer","description":"<para type=\"description\">VRRP broadcast interval</para>","format":"int32"},"vrrpHealthCheckInterval":{"type":"integer","description":"<para type=\"description\">VRRP health script check interval</para>","format":"int32"},"vrrpHealthCheckTimeout":{"type":"integer","description":"<para type=\"description\">VRRP health script check timeout</para>","format":"int32"},"vrrpAdvertInterval":{"type":"integer","description":"<para type=\"description\">VRRP advertisement interval</para>","format":"int32"},"keepLBProxyConfig":{"type":"boolean","description":"<para type=\"description\">Keep existing load balancing settings</para>"},"keepVRRPConfig":{"type":"boolean","description":"<para type=\"description\">Keep existing VRRP/keepalived setting</para>"},"clientManagementConfig":{"$ref":"#/components/schemas/HALBClientManagerConfigSettings"},"gatewayConfig":{"$ref":"#/components/schemas/HALBGatewayConfigSettings"},"sslConfig":{"$ref":"#/components/schemas/HALBSSLConfigSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Virtual Server settings</para>\r\n<para type=\"description\"></para>"},"IPVersion":{"enum":[["0 = Version4","1 = Version6","2 = BothVersions"]],"type":"string","description":"<para type=\"synopsis\">IP Version</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"HALBDevice":{"type":"object","properties":{"deviceIP":{"type":"string","description":"<para type=\"description\">IP of the HALB Device</para>","nullable":true},"deviceId":{"type":"integer","description":"<para type=\"description\">ID of the HALB Device</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Device</para>\r\n<para type=\"description\"></para>"},"LoadBalancingAlgorithm":{"enum":[["0 = SourceIP","1 = Cookie"]],"type":"string","description":"<para type=\"synopsis\">Load Balancing Algorithm</para>\r\n<para type=\"description\"></para>","format":"int32"},"HALBClientManagerConfigSettings":{"type":"object","properties":{"gateways":{"type":"object","additionalProperties":{"type":"integer","format":"int32","nullable":true},"description":"<para type=\"description\">Dictionary of Gateways for these settings</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Device Manager configuration settings</para>\r\n<para type=\"description\"></para>"},"HALBGatewayConfigSettings":{"type":"object","properties":{"port":{"type":"integer","description":"<para type=\"description\">Gateway Port</para>","format":"int32"},"gateways":{"type":"object","additionalProperties":{"type":"integer","format":"int32","nullable":true},"description":"<para type=\"description\">Dictionary of Gateways for these settings</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Gateway configuration settings</para>\r\n<para type=\"description\"></para>"},"HALBSSLConfigSettings":{"type":"object","properties":{"minSSLVersion":{"$ref":"#/components/schemas/AcceptedSSLVersion"},"sslMode":{"$ref":"#/components/schemas/LoadBalancingSSLMode"},"sslCustomCipher":{"type":"string","description":"<para type=\"description\">SSL Custom Cipher</para>","nullable":true},"sslCipherStrength":{"$ref":"#/components/schemas/CipherStrength"},"sslCipherPreference":{"type":"boolean","description":"<para type=\"description\">Enable or disable 'Use ciphers according to server preference'.</para>"},"certID":{"type":"integer","description":"<para type=\"description\">Certificate ID</para>","format":"int32"},"gatewayConfig":{"$ref":"#/components/schemas/HALBGatewayConfigSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB SSL configuration settings</para>\r\n<para type=\"description\"></para>"},"AcceptedSSLVersion":{"enum":[["2 = TLSv1","3 = TLSv1_1","4 = TLSv1_2","5 = TLSv1_3"]],"type":"string","description":"<para type=\"synopsis\">Accepted SSL Versions</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"LoadBalancingSSLMode":{"enum":[["0 = SSLOffloading","1 = SSLPassthrough"]],"type":"string","description":"<para type=\"synopsis\">Load Balancing SSL Mode</para>\r\n<para type=\"description\"></para>","format":"int32"},"CipherStrength":{"enum":[["0 = Low","1 = Medium","2 = High","3 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Cipher Strength</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Create

> Create a new entry for the HALB Virtual Server settings

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/HALB":{"post":{"tags":["0-Infrastructure/HALBs//0-Basic Operations"],"summary":"Create","description":"Create a new entry for the HALB Virtual Server settings","operationId":"d3d5ba65-000e-4d97-9e57-d9e721bf2ead","parameters":[{"name":"noInstall","in":"query","description":"Set it to true if HALB Devices should be initialized after being added. (optional)","schema":{"type":"boolean"}}],"requestBody":{"description":"The HALB Virtual Server settings","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewHALB"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/HALBSettings"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewHALB":{"required":["ipVersion","name"],"type":"object","properties":{"description":{"maxLength":127,"minLength":1,"type":"string","description":"<para type=\"description\">The HALB Virtual Server description.</para>","nullable":true},"publicAddress":{"type":"string","description":"<para type=\"description\">The HALB Virtual Server Public Address.</para>","nullable":true},"virtualIPv4":{"type":"string","description":"<para type=\"description\">The IPv4 of the HALB Virtual Server.</para>","nullable":true},"subnetMask":{"type":"string","description":"<para type=\"description\">The Subnet Mask of the HALB Virtual Server.</para>","nullable":true},"virtualIPv6":{"type":"string","description":"<para type=\"description\">The IPv6 of the HALB Virtual Server.</para>","nullable":true},"prefixIPV6":{"type":"integer","description":"<para type=\"description\">The IPv6 Prefix of the HALB Virtual Server.</para>","format":"int32","nullable":true},"enableTunneling":{"type":"boolean","description":"<para type=\"description\">Enable/Disable the RDP/UDP of the HALB Virtual Server.</para>","nullable":true},"maxTCPConnections":{"type":"integer","description":"<para type=\"description\">The Maximum allowed TCP Connections to the HALB Virtual Server.</para>","format":"int32","nullable":true},"vrrpAuthenticationPassword":{"type":"string","description":"<para type=\"description\">The VRRP Authentication password.</para>","nullable":true},"clientIdleTimeout":{"type":"integer","description":"<para type=\"description\">The client inactivity timeout.</para>","format":"int32","nullable":true},"gatewayConnectionTimeout":{"type":"integer","description":"<para type=\"description\">The Gateway connection timeout.</para>","format":"int32","nullable":true},"clientQueueTimeout":{"type":"integer","description":"<para type=\"description\">The client queue timeout.</para>","format":"int32","nullable":true},"gatewayIdleTimeout":{"type":"integer","description":"<para type=\"description\">The Gateway inactivity timeout.</para>","format":"int32","nullable":true},"sessionRate":{"type":"integer","description":"<para type=\"description\">The amount of TCP connections per second.</para>","format":"int32","nullable":true},"gatewayHealthCheckIntervals":{"type":"integer","description":"<para type=\"description\">The Gateway Health check intervals in seconds.</para>","format":"int32","nullable":true},"vrrpVirtualRouterID":{"type":"integer","description":"<para type=\"description\">The Virtual Router ID of HALB Virtual Server (if not set, the router ID will be automatically computed).</para>","format":"int32","nullable":true},"vrrpBroadcastInterval":{"type":"integer","description":"<para type=\"description\">The VRRP broadcast interval in minutes.</para>","format":"int32","nullable":true},"vrrpHealthScriptCheckInterval":{"type":"integer","description":"<para type=\"description\">The VRRP health script check interval in seconds.</para>","format":"int32","nullable":true},"vrrpHealthScriptCheckTimeout":{"type":"integer","description":"<para type=\"description\">The VRRP health script check timeout in seconds.</para>","format":"int32","nullable":true},"vrrpAdvertisementInterval":{"type":"integer","description":"<para type=\"description\">The VRRP Advertisement interval in seconds.</para>","format":"int32","nullable":true},"keepLBProxyConfig":{"type":"boolean","description":"<para type=\"description\">Enable/Disable keeping of existing loadbalancing settings.</para>","nullable":true},"keepVRRPConfig":{"type":"boolean","description":"<para type=\"description\">Enable/Disable keeping of existing VRRP/keepalive settings.</para>","nullable":true},"lbGateways":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">The list of the Non-SSL Gateways for HALB Virtual Server.</para>","nullable":true},"lbGatewayPort":{"type":"integer","description":"<para type=\"description\">The Non-SSL Gateway port.</para>","format":"int32","nullable":true},"sslMode":{"$ref":"#/components/schemas/LoadBalancingSSLMode"},"lbsslGateways":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">The list of the SSL Gateways for HALB Virtual Server.</para>","nullable":true},"lbsslGatewayPort":{"type":"integer","description":"<para type=\"description\">The SSL Gateway port.</para>","format":"int32","nullable":true},"acceptedSSLVersion":{"$ref":"#/components/schemas/AcceptedSSLVersion"},"cipherStrength":{"$ref":"#/components/schemas/CipherStrength"},"cipherPreference":{"type":"boolean","description":"<para type=\"description\">Enable or disable 'Use ciphers according to server preference'.</para>","nullable":true},"sslCustomCipher":{"maxLength":512,"minLength":1,"type":"string","description":"<para type=\"description\">The SSL custom cipher for SSL Gateways.</para>","nullable":true},"certificateID":{"type":"integer","description":"<para type=\"description\">The certificate ID.</para>","format":"int32","nullable":true},"deviceManagerGateways":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">The list of the Device Management Gateways for HALB Virtual Server.</para>","nullable":true},"name":{"maxLength":127,"minLength":1,"type":"string","description":"<para type=\"description\">The HALB Virtual Server name.</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">The site ID where the HALB settings will be created.</para>","format":"int32"},"ipVersion":{"$ref":"#/components/schemas/IPVersion"},"deviceIPs":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">The list of the HALB Device IPs.</para>","nullable":true},"enableGatewayPayload":{"type":"boolean","description":"<para type=\"description\">Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server .</para>","default":false},"enableSSLPayload":{"type":"boolean","description":"<para type=\"description\">Enable/Disable the SSL Gateway configuration of the HALB Virtual Server.</para>","default":false},"enableDeviceManagement":{"type":"boolean","description":"<para type=\"description\">Enable/Disable the Device Management configuration of the HALB Virtual Server.</para>","default":false}},"additionalProperties":false,"description":"<para type=\"synopsis\">Create a new HALB Virtual Server</para>\r\n<para type=\"description\"></para>"},"LoadBalancingSSLMode":{"enum":[["0 = SSLOffloading","1 = SSLPassthrough"]],"type":"string","description":"<para type=\"synopsis\">Load Balancing SSL Mode</para>\r\n<para type=\"description\"></para>","format":"int32"},"AcceptedSSLVersion":{"enum":[["2 = TLSv1","3 = TLSv1_1","4 = TLSv1_2","5 = TLSv1_3"]],"type":"string","description":"<para type=\"synopsis\">Accepted SSL Versions</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"CipherStrength":{"enum":[["0 = Low","1 = Medium","2 = High","3 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Cipher Strength</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"IPVersion":{"enum":[["0 = Version4","1 = Version6","2 = BothVersions"]],"type":"string","description":"<para type=\"synopsis\">IP Version</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"HALBSettings":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Appliance name.</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">The site ID of this HALB Virtual Server.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Appliance description.</para>","nullable":true},"publicAddress":{"type":"string","description":"<para type=\"description\">The Public Address of the HALB.</para>","nullable":true},"enableGatewayPayload":{"type":"boolean","description":"<para type=\"description\">Whether the Gateway payload is enabled or not.</para>"},"enableSSLPayload":{"type":"boolean","description":"<para type=\"description\">Whether the SSL payload is enabled or not.</para>"},"enableHALBInstance":{"type":"boolean","description":"<para type=\"description\">Whether the HALB instance is enabled or not.</para>"},"enableDeviceManagement":{"type":"boolean","description":"<para type=\"description\">Whether the Device Management is enabled or not.</para>"},"ipVersion":{"$ref":"#/components/schemas/IPVersion"},"virtualIPV4":{"type":"string","description":"<para type=\"description\">Virtual IP Version 4</para>","nullable":true},"subNetMask":{"type":"string","description":"<para type=\"description\">SubNet Mask</para>","nullable":true},"virtualIPV6":{"type":"string","description":"<para type=\"description\">Virtual IP Version 6</para>","nullable":true},"prefixIPV6":{"type":"integer","description":"<para type=\"description\">Prefix for IP Version 6</para>","format":"int32"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/HALBDevice"},"description":"<para type=\"description\">A collection of HALB Devices</para>","nullable":true},"enableUDPTunneling":{"type":"boolean","description":"<para type=\"description\">Whether RDP UDP tunneling is enabled or not.</para>"},"maxTCPConnections":{"type":"integer","description":"<para type=\"description\">Maximum number of TCP connections.</para>","format":"int32"},"algorithm":{"$ref":"#/components/schemas/LoadBalancingAlgorithm"},"clientIdleTimeout":{"type":"integer","description":"<para type=\"description\">Client inactivity timeout</para>","format":"int32"},"gatewayConnectionTimeout":{"type":"integer","description":"<para type=\"description\">Gateway connection timeout</para>","format":"int32"},"clientQueueTimeout":{"type":"integer","description":"<para type=\"description\">Client connection queue timeout</para>","format":"int32"},"gatewayIdleTimeout":{"type":"integer","description":"<para type=\"description\">Gateway inactivity timeout</para>","format":"int32"},"sessionsRate":{"type":"integer","description":"<para type=\"description\">Amount of TCP connections per second</para>","format":"int32"},"gatewayHealthCheckInterval":{"type":"integer","description":"<para type=\"description\">Gateways health check intervals</para>","format":"int32"},"virtualRouterID":{"type":"integer","description":"<para type=\"description\">VRRP virtual router ID</para>\r\n<para type=\"description\">Value between 0 and 255 unique per site. Value should be randomized to increase probability that it's also unique between farms.</para>","format":"int32"},"vrrpBroadcastInterval":{"type":"integer","description":"<para type=\"description\">VRRP broadcast interval</para>","format":"int32"},"vrrpHealthCheckInterval":{"type":"integer","description":"<para type=\"description\">VRRP health script check interval</para>","format":"int32"},"vrrpHealthCheckTimeout":{"type":"integer","description":"<para type=\"description\">VRRP health script check timeout</para>","format":"int32"},"vrrpAdvertInterval":{"type":"integer","description":"<para type=\"description\">VRRP advertisement interval</para>","format":"int32"},"keepLBProxyConfig":{"type":"boolean","description":"<para type=\"description\">Keep existing load balancing settings</para>"},"keepVRRPConfig":{"type":"boolean","description":"<para type=\"description\">Keep existing VRRP/keepalived setting</para>"},"clientManagementConfig":{"$ref":"#/components/schemas/HALBClientManagerConfigSettings"},"gatewayConfig":{"$ref":"#/components/schemas/HALBGatewayConfigSettings"},"sslConfig":{"$ref":"#/components/schemas/HALBSSLConfigSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Virtual Server settings</para>\r\n<para type=\"description\"></para>"},"HALBDevice":{"type":"object","properties":{"deviceIP":{"type":"string","description":"<para type=\"description\">IP of the HALB Device</para>","nullable":true},"deviceId":{"type":"integer","description":"<para type=\"description\">ID of the HALB Device</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Device</para>\r\n<para type=\"description\"></para>"},"LoadBalancingAlgorithm":{"enum":[["0 = SourceIP","1 = Cookie"]],"type":"string","description":"<para type=\"synopsis\">Load Balancing Algorithm</para>\r\n<para type=\"description\"></para>","format":"int32"},"HALBClientManagerConfigSettings":{"type":"object","properties":{"gateways":{"type":"object","additionalProperties":{"type":"integer","format":"int32","nullable":true},"description":"<para type=\"description\">Dictionary of Gateways for these settings</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Device Manager configuration settings</para>\r\n<para type=\"description\"></para>"},"HALBGatewayConfigSettings":{"type":"object","properties":{"port":{"type":"integer","description":"<para type=\"description\">Gateway Port</para>","format":"int32"},"gateways":{"type":"object","additionalProperties":{"type":"integer","format":"int32","nullable":true},"description":"<para type=\"description\">Dictionary of Gateways for these settings</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB Gateway configuration settings</para>\r\n<para type=\"description\"></para>"},"HALBSSLConfigSettings":{"type":"object","properties":{"minSSLVersion":{"$ref":"#/components/schemas/AcceptedSSLVersion"},"sslMode":{"$ref":"#/components/schemas/LoadBalancingSSLMode"},"sslCustomCipher":{"type":"string","description":"<para type=\"description\">SSL Custom Cipher</para>","nullable":true},"sslCipherStrength":{"$ref":"#/components/schemas/CipherStrength"},"sslCipherPreference":{"type":"boolean","description":"<para type=\"description\">Enable or disable 'Use ciphers according to server preference'.</para>"},"certID":{"type":"integer","description":"<para type=\"description\">Certificate ID</para>","format":"int32"},"gatewayConfig":{"$ref":"#/components/schemas/HALBGatewayConfigSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">HALB SSL configuration settings</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

{% openapi src="/files/oEgjY6sMA31ZVBC35aoj" path="/api/HALB/{id}" method="get" %}
[swagger 1.json](https://content.gitbook.com/content/jyGAUPrA6XIdGAfHCnJE/blobs/7mKwtvutT7xlWtmCVnxB/swagger%201.json)
{% endopenapi %}

{% openapi src="/files/oEgjY6sMA31ZVBC35aoj" path="/api/HALB/{id}" method="put" %}
[swagger 1.json](https://content.gitbook.com/content/jyGAUPrA6XIdGAfHCnJE/blobs/7mKwtvutT7xlWtmCVnxB/swagger%201.json)
{% endopenapi %}

{% openapi src="/files/oEgjY6sMA31ZVBC35aoj" path="/api/HALB/{id}" method="delete" %}
[swagger 1.json](https://content.gitbook.com/content/jyGAUPrA6XIdGAfHCnJE/blobs/7mKwtvutT7xlWtmCVnxB/swagger%201.json)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/infrastructure/halbs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.