Class LoadBalancerActions

Load Balancer Actions API

Load balancer actions are used to manage load balancers. https://docs.hetzner.cloud/#load-balancers-actions

Hierarchy (View Summary)

BaseAPI
- LoadBalancerActions

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

addService

addService(
    loadBalancerId: number,
    params: AddServiceLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: AddServiceLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:114

addTarget

addTarget(
    loadBalancerId: number,
    params: AddTargetLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: AddTargetLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:150

attachToNetwork

attachToNetwork(
    loadBalancerId: number,
    params: AttachToNetworkLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: AttachToNetworkLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:174

changeAlgorithm

changeAlgorithm(
    loadBalancerId: number,
    params: ChangeAlgorithmLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: ChangeAlgorithmLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:198

changeDNSPTR

changeDNSPTR(
    loadBalancerId: number,
    params: ChangeDNSPTRLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: ChangeDNSPTRLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:210

changeProtection

changeProtection(
    loadBalancerId: number,
    params: ChangeProtectionLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: ChangeProtectionLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:222

changeType

changeType(
    loadBalancerId: number,
    params: ChangeTypeLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: ChangeTypeLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:234

deleteService

deleteService(
    loadBalancerId: number,
    params: DeleteServiceLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: DeleteServiceLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:138

detachFromNetwork

detachFromNetwork(
    loadBalancerId: number,
    params: DetachFromNetworkLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: DetachFromNetworkLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:186

disablePublicInterface

disablePublicInterface(
    loadBalancerId: number,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:257

enablePublicInterface

enablePublicInterface(
    loadBalancerId: number,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:246

getAction

getAction(
    loadBalancerId: number,
    actionId: number,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a specific Load Balancer
Parameters
- loadBalancerId: number
  The Load Balancer ID
- actionId: number
  The action ID
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:103

getAllGlobal

getAllGlobal(
    params?: ListLoadBalancerActionsParams,
): Promise<
    | { response: LoadBalancerActionsResponse; success: true }
    | { response: APIError; success: false },
>
List all global actions for Load Balancers
Parameters
- Optionalparams: ListLoadBalancerActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: LoadBalancerActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:32

getGlobalAction

getGlobalAction(
    actionId: number,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific global action for Load Balancers
Parameters
- actionId: number
  The action ID
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:60

listForLoadBalancer

listForLoadBalancer(
    loadBalancerId: number,
    params?: ListLoadBalancerActionsParams,
): Promise<
    | { response: LoadBalancerActionsResponse; success: true }
    | { response: APIError; success: false },
>
List actions for a specific Load Balancer
Parameters
- loadBalancerId: number
  The Load Balancer ID
- Optionalparams: ListLoadBalancerActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: LoadBalancerActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:73

removeTarget

removeTarget(
    loadBalancerId: number,
    params: RemoveTargetLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: RemoveTargetLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:162

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

updateService

updateService(
    loadBalancerId: number,
    params: UpdateServiceLoadBalancerParams,
): Promise<
    | { response: LoadBalancerActionResponse; success: true }
    | { response: APIError; success: false },
>
Parameters
- loadBalancerId: number
- params: UpdateServiceLoadBalancerParams
Returns Promise<
| { response: LoadBalancerActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in load-balancers/actions.ts:126

Class LoadBalancerActions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LoadBalancerActions

Properties

ProtectedbaseUrl

Protectedtoken

Methods

addService

Parameters

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

addTarget

Parameters

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

attachToNetwork

Parameters

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

changeAlgorithm

Parameters

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

changeDNSPTR

Parameters

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

changeProtection

Parameters

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

changeType

Parameters

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

deleteService

Parameters

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

detachFromNetwork

Parameters

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

disablePublicInterface

Parameters

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

enablePublicInterface

Parameters

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

getAction

Parameters

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

getAllGlobal

Parameters

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

getGlobalAction

Parameters

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

listForLoadBalancer

Parameters

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

removeTarget

Parameters

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

request

Type Parameters

Parameters

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

updateService

Parameters

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

Settings

On This Page

`Protected`baseUrl

`Protected`token

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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