Get load balancer rule

GET 
/load_balancers/rules/load_balancer_rule

Returns details about a load balancer rule

Scopes

• load_balancers
• load_balancers:read

OAuth2 Scopes

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

Request

Query Parameters

load_balancer_rule[id] string

The load balancer rule to return the details for.

Responses

200

Returns details about a load balancer rule

application/json

Schema

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

Example (from schema)

{
  "load_balancer_rule": {
    "id": "string",
    "algorithm": "round_robin",
    "destination_port": 0,
    "listen_port": 0,
    "protocol": "HTTPS",
    "proxy_protocol": true,
    "certificates": [
      {
        "id": "string",
        "name": "string",
        "additional_names": [
          "string"
        ],
        "state": "pending"
      }
    ],
    "backend_ssl": true,
    "passthrough_ssl": true,
    "check_enabled": true,
    "check_fall": 0,
    "check_interval": 0,
    "check_path": "string",
    "check_protocol": "HTTP",
    "check_rise": 0,
    "check_timeout": 0,
    "check_http_statuses": "2",
    "load_balancer": {
      "id": "string",
      "name": "string"
    }
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

404

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

application/json

Schema

Schema

code LoadBalancerRuleNotFoundEnum (string)

Possible values: [load_balancer_rule_not_found]

description string
detail object

Example (from schema)

{
  "code": "load_balancer_rule_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...