DELETE /v2/load_balancers/{lb_id}/forwarding_rules

To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

Servers

Path parameters

Name Type Required Description
lb_id String Yes

A unique identifier for a 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
forwarding_rules[] Array Yes
forwarding_rules[].entry_protocol String Yes

The protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Possible values:

  • "tcp"
  • "udp"
  • "http"
  • "https"
  • "http3"
  • "http2"
forwarding_rules[].target_protocol String Yes

The protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Possible values:

  • "tcp"
  • "udp"
  • "http"
  • "https"
  • "http2"
forwarding_rules[].tls_passthrough Boolean No

A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

forwarding_rules[].entry_port Integer Yes

An integer representing the port on which the load balancer instance will listen.

forwarding_rules[].target_port Integer Yes

An integer representing the port on the backend Droplets to which the load balancer will send traffic.

forwarding_rules[].certificate_id String No

The ID of the TLS certificate used for SSL termination if enabled.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.