Class LoadBalancers

Load Balancers API

Load Balancers can be used to load balance traffic between multiple servers. https://docs.hetzner.cloud/#load-balancers

Hierarchy (View Summary)

BaseAPI
- LoadBalancers

Index

Constructors

constructor

new LoadBalancers(token: string, baseUrl?: string): LoadBalancers
Parameters
- token: string
- OptionalbaseUrl: string
Returns LoadBalancers
Inherited from BaseAPI.constructor
- Defined in base.ts:7

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): LoadBalancerActions
Returns LoadBalancerActions
- Defined in load-balancers/load-balancers.ts:168

Methods

create

create(
    params: CreateLoadBalancerParams,
): Promise<
    | { response: CreateLoadBalancerResponse; success: true }
    | { response: APIError; success: false },
>
Create a new Load Balancer
Parameters
- params: CreateLoadBalancerParams
Returns Promise<
| { response: CreateLoadBalancerResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:54

delete

delete(
    id: number,
): Promise<
    | { response: null
    | LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Delete a Load Balancer
Parameters
- id: number
Returns Promise<
    | { response: null
    | LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:97

get

get(
    id: number,
): Promise<
    | { response: LoadBalancerResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific Load Balancer by ID
Parameters
- id: number
Returns Promise<
| { response: LoadBalancerResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:69

getAll

getAll(
    params?: ListLoadBalancersParams,
): Promise<
    | { response: LoadBalancersResponse; success: true }
    | { response: APIError; success: false },
>
List all Load Balancers
Parameters
- Optionalparams: ListLoadBalancersParams
Returns Promise<
| { response: LoadBalancersResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:31

getMetrics

getMetrics(
    id: number,
    params: GetLoadBalancerMetricsParams,
): Promise<
    | { response: LoadBalancerMetricsResponse; success: true }
    | { response: APIError; success: false },
>
Get Metrics for a Load Balancer
Parameters
- id: number
- params: GetLoadBalancerMetricsParams
Returns Promise<
| { response: LoadBalancerMetricsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:112

getType

getType(
    id: number,
): Promise<
    | { response: LoadBalancerTypesResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific Load Balancer Type by ID
Parameters
- id: number
Returns Promise<
| { response: LoadBalancerTypesResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:157

listTypes

listTypes(
    params?: ListLoadBalancerTypesParams,
): Promise<
    | { response: LoadBalancerTypesResponse; success: true }
    | { response: APIError; success: false },
>
List all Load Balancer Types
Parameters
- Optionalparams: ListLoadBalancerTypesParams
Returns Promise<
| { response: LoadBalancerTypesResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:134

request

request<T>(
    endpoint: string,
    options?: RequestInit,
): Promise<
    { response: T; success: true }
    | { response: APIError; success: false },
>
Type Parameters
- T
Parameters
- endpoint: string
- options: RequestInit = {}
Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>
Inherited from BaseAPI.request
- Defined in base.ts:12

update

update(
    id: number,
    params: UpdateLoadBalancerParams,
): Promise<
    | { response: LoadBalancerResponse; success: true }
    | { response: APIError; success: false },
>
Update a Load Balancer
Parameters
- id: number
- params: UpdateLoadBalancerParams
Returns Promise<
| { response: LoadBalancerResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/load-balancers.ts:81

Class LoadBalancers

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LoadBalancers

Properties

ProtectedbaseUrl

Protectedtoken

Accessors

actions

Returns LoadBalancerActions

Methods

create

Parameters

Returns Promise< | { response: CreateLoadBalancerResponse; success: true } | { response: APIError; success: false },>

delete

Parameters

Returns Promise< | { response: null | LoadBalancerActionResponse; success: true } | { response: APIError; success: false },>

get

Parameters

Returns Promise< | { response: LoadBalancerResponse; success: true } | { response: APIError; success: false },>

getAll

Parameters

Returns Promise< | { response: LoadBalancersResponse; success: true } | { response: APIError; success: false },>

getMetrics

Parameters

Returns Promise< | { response: LoadBalancerMetricsResponse; success: true } | { response: APIError; success: false },>

getType

Parameters

Returns Promise< | { response: LoadBalancerTypesResponse; success: true } | { response: APIError; success: false },>

listTypes

Parameters

Returns Promise< | { response: LoadBalancerTypesResponse; success: true } | { response: APIError; success: false },>

request

Type Parameters

Parameters

Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>

update

Parameters

Returns Promise< | { response: LoadBalancerResponse; success: true } | { response: APIError; success: false },>

Settings

On This Page

`Protected`baseUrl

`Protected`token

Returns Promise<
| { response: CreateLoadBalancerResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: null
| LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancerResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancersResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancerMetricsResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancerTypesResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancerTypesResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: LoadBalancerResponse; success: true }
| { response: APIError; success: false },
>