API Reference

Katapult Core API

Resources & Endpoints

Get load balancer rule

Returns details about a load balancer rule.

GET
https://api.katapult.io/core/v1/load_balancers/rules/{load_balancer_rule}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

load_balancer_rule Required

The load balancer rule to return the details for

 Load balancer rule lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

load_balancer_rule_not_found

No load balancer rule was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    load_balancer_rule: LoadBalancerRule {
        id: String
        algorithm: LoadBalancerRuleAlgorithmEnum
        destination_port: Integer
        listen_port: Integer
        protocol: LoadBalancerRuleProtocolEnum
        proxy_protocol: Boolean
        certificates: [ Certificate {
            id: String
            name: String
            additional_names: [ String ]
            state: CertificateStateEnum
        } ]
        backend_ssl: Boolean
        passthrough_ssl: Boolean
        check_enabled: Boolean
        check_fall: Integer
        check_interval: Integer
        check_path: String
        check_protocol: LoadBalancerRuleCheckProtocolEnum?
        check_rise: Integer
        check_timeout: Integer
        check_http_statuses: LoadBalancerRuleHTTPStatusesEnum?
        load_balancer: LoadBalancer {
            id: String
            name: String
        }
    }
}