POST /load_balancers/{id}/actions/add_service

Adds a service to a Load Balancer.

Call specific error codes

Code	Description
`source_port_already_used`	The source port you are trying to add is already in use

Servers

https://api.hetzner.cloud/v1

Path parameters

Name	Type	Required	Description
`id`	Integer	Yes	ID of the Load Balancer.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`destination_port`	Integer	Yes	Port the Load Balancer will balance to
`proxyprotocol`	Boolean	Yes	Is Proxyprotocol enabled or not
`health_check`	Object	Yes	Service health check
`health_check.port`	Integer	Yes	Port the health check will be performed on
`health_check.interval`	Integer	Yes	Time interval in seconds health checks are performed
`health_check.protocol`	String	Yes	Type of the health check Possible values: `"tcp"` `"http"`
`health_check.timeout`	Integer	Yes	Time in seconds after an attempt is considered a timeout
`health_check.retries`	Integer	Yes	Unsuccessful retries needed until a target is considered unhealthy; an unhealthy target needs the same number of successful retries to become healthy again
`health_check.http`	Object	No	Additional configuration for protocol http
`health_check.http.status_codes[]`	Array	No	List of returned HTTP status codes in order to pass the health check. Supports the wildcards `?` for exactly one character and `*` for multiple ones. Default value: [ "2??", "3??" ]
`health_check.http.response`	String	No	String that must be contained in HTTP response in order to pass the health check
`health_check.http.tls`	Boolean	No	Use HTTPS for health check
`health_check.http.domain`	String	Yes	Host header to send in the HTTP request. May not contain spaces, percent or backslash symbols. Can be null, in that case no host header is sent.
`health_check.http.path`	String	Yes	HTTP path to use for health checks. May not contain literal spaces, use percent-encoding instead.
`listen_port`	Integer	Yes	Port the Load Balancer listens on
`protocol`	String	Yes	Protocol of the Load Balancer Possible values: `"tcp"` `"http"` `"https"`
`http`	Object	No	Configuration option for protocols http and https
`http.cookie_name`	String	No	Name of the cookie used for sticky sessions. Default value: "HCLBSTICKY"
`http.cookie_lifetime`	Integer	No	Lifetime of the cookie used for sticky sessions (in seconds). Default value: 300
`http.certificates[]`	Array	No	IDs of the Certificates to use for TLS/SSL termination by the Load Balancer; empty for TLS/SSL passthrough or if `protocol` is `http`.
`http.sticky_sessions`	Boolean	No	Use sticky sessions. Only available if `protocol` is `http` or `https`. Default value: false
`http.redirect_http`	Boolean	No	Redirect HTTP requests to HTTPS. Only available if `protocol` is `https`. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.