List load balancer rules

GET 
/load_balancers/load_balancer/rules

Returns a list of all rules for a given load balancer

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[id] string

The load balancer to return all load rules for.

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

load_balancer[api_reference] string

The load balancer to return all load rules for.

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

page integer

Possible values: >= 1

Default value: 1

The page number to request. If not provided, the first page will be returned.

per_page integer

Possible values: >= 1

Default value: 30

The number of items to return per page. If not provided, the default value will be used.

Responses

200

Returns a list of all rules for a given load balancer

application/json

Schema

Schema

pagination

object

required

current_page integer

The current page

total_pages integernullable

The total number of pages

total integernullable

The total number of items across all pages

per_page integer

The number of items per page

large_set boolean

Is this a large set and therefore the total number of records cannot be returned?

load_balancer_rules

object[]

required

The load balancer rules for this load balancer

Array [

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]

certificates

object[]

Array [

id string

name string

]

check_enabled boolean

]

Example (from schema)

{
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total": 0,
    "per_page": 0,
    "large_set": true
  },
  "load_balancer_rules": [
    {
      "id": "string",
      "algorithm": "round_robin",
      "destination_port": 0,
      "listen_port": 0,
      "protocol": "HTTPS",
      "certificates": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "check_enabled": true
    }
  ]
}

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[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

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

application/json

Schema

Schema

code LoadBalancerNotFoundEnum (string)

Possible values: [load_balancer_not_found]

description string
detail object

Example (from schema)

{
  "code": "load_balancer_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...