Skip to main content

Create load balancer rule

POST 

/load_balancers/load_balancer/rules

Create a new load balancer rule

Scopes

  • load_balancers

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Body

    load_balancer

    object

    required

    All 'load_balancer[]' params are mutually exclusive, only one can be provided.

    id string
    api_reference string

    properties

    object

    required

    algorithm LoadBalancerRuleAlgorithmEnum (string)

    Possible values: [round_robin, least_connections, sticky]

    destination_port integer
    listen_port integer
    protocol LoadBalancerRuleProtocolEnum (string)

    Possible values: [HTTPS, TCP, HTTP]

    proxy_protocol boolean
    backend_ssl boolean
    passthrough_ssl boolean

    certificates

    object[]

  • Array [

  • id string
  • ]

  • check_enabled boolean
    check_fall integer
    check_interval integer
    check_path string
    check_protocol LoadBalancerRuleCheckProtocolEnum (string)

    Possible values: [HTTP, TCP]

    check_rise integer
    check_timeout integer
    check_http_statuses LoadBalancerRuleHTTPStatusesEnum (string)

    Possible values: [2, 23, 234]

Responses

Create a new load balancer rule

Schema

    load_balancer_rule

    object

    required

    id string
    algorithm LoadBalancerRuleAlgorithmEnum (string)

    Possible values: [round_robin, least_connections, sticky]

    destination_port integer
    listen_port integer
    protocol LoadBalancerRuleProtocolEnum (string)

    Possible values: [HTTPS, TCP, HTTP]

    proxy_protocol boolean

    certificates

    object[]

  • Array [

  • id string
    name string
    additional_names string[]
    state CertificateStateEnum (string)

    Possible values: [pending, issue_failed, issued, issuing]

  • ]

  • backend_ssl boolean
    passthrough_ssl boolean
    check_enabled boolean
    check_fall integer
    check_interval integer
    check_path string
    check_protocol LoadBalancerRuleCheckProtocolEnum (string)nullable

    Possible values: [HTTP, TCP]

    check_rise integer
    check_timeout integer
    check_http_statuses LoadBalancerRuleHTTPStatusesEnum (string)nullable

    Possible values: [2, 23, 234]

    load_balancer

    object

    id string
    name string
Loading...