hetzner/load_balancer_actions

Search:
Group by:

Types

LoadBalancerActionSortOption = enum
  sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc",
  sortCommand = "command", sortCommandAsc = "command:asc",
  sortCommandDesc = "command:desc", sortStatus = "status",
  sortStatusAsc = "status:asc", sortStatusDesc = "status:desc",
  sortProgress = "progress", sortProgressAsc = "progress:asc",
  sortProgressDesc = "progress:desc", sortStarted = "started",
  sortStartedAsc = "started:asc", sortStartedDesc = "started:desc",
  sortFinished = "finished", sortFinishedAsc = "finished:asc",
  sortFinishedDesc = "finished:desc"
LoadBalancerActionStatusOption = enum
  statusRunning = "running", statusSuccess = "success", statusError = "error"

Procs

proc getLoadBalancersIdActions(client: HetznerClient; id: int64;
                               sort: set[LoadBalancerActionSortOption] = {};
                               status: set[LoadBalancerActionStatusOption] = {}): Future[
    GetLoadBalancersIdActionsResponse] {....stackTrace: false, raises: [Exception,
    ValueError, KeyError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns all Action objects for a Load Balancer. You can sort the results by using the sort URI parameter, and filter them with the status parameter. 
proc getLoadBalancersIdActionsActionId(client: HetznerClient; id: int64;
                                       actionId: int64): Future[
    GetLoadBalancersIdActionsActionIdResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns a specific Action for a Load Balancer. 
proc postLoadBalancersIdActionsAddService(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsAddServiceRequest): Future[
    PostLoadBalancersIdActionsAddServiceResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Adds a service to a Load Balancer.

#### Call specific error codes

| Code                       | Description
|
|----------------------------|--------------------------------------------------
-------|
| `source_port_already_used` | The source port you are trying to add is already
in use |
proc postLoadBalancersIdActionsAddTarget(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsAddTargetRequest): Future[
    PostLoadBalancersIdActionsAddTargetResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Adds a target to a Load Balancer.

#### Call specific error codes

| Code                                    | Description
|
|-----------------------------------------|-------------------------------------
------------------------------------------------------------------|
| `cloud_resource_ip_not_allowed`         | The IP you are trying to add as a
target belongs to a Hetzner Cloud resource                          |
| `ip_not_owned`                          | The IP you are trying to add as a
target is not owned by the Project owner                            |
| `load_balancer_not_attached_to_network` | The Load Balancer is not attached to
a network                                                        |
| `robot_unavailable`                     | Robot was not available. The caller
may retry the operation after a short delay.                      |
| `server_not_attached_to_network`        | The server you are trying to add as
a target is not attached to the same network as the Load Balancer |
| `target_already_defined`                | The Load Balancer target you are
trying to define is already defined                                  |
proc postLoadBalancersIdActionsAttachToNetwork(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsAttachToNetworkRequest): Future[
    PostLoadBalancersIdActionsAttachToNetworkResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Attach a Load Balancer to a Network.

**Call specific error codes**

| Code                             | Description
|
|----------------------------------|--------------------------------------------
---------------------------|
| `load_balancer_already_attached` | The Load Balancer is already attached to a
network                    |
| `ip_not_available`               | The provided Network IP is not available
|
| `no_subnet_available`            | No Subnet or IP is available for the Load
Balancer within the network |
proc postLoadBalancersIdActionsChangeAlgorithm(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsChangeAlgorithmRequest): Future[
    PostLoadBalancersIdActionsChangeAlgorithmResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Change the algorithm that determines to which target new requests are sent. 
proc postLoadBalancersIdActionsChangeDnsPtr(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsChangeDnsPtrRequest): Future[
    PostLoadBalancersIdActionsChangeDnsPtrResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}

Changes the hostname that will appear when getting the hostname belonging to the public IPs (IPv4 and IPv6) of this Load Balancer.

Floating IPs assigned to the Server are not affected by this.

proc postLoadBalancersIdActionsChangeProtection(client: HetznerClient;
    id: int64; body: PostLoadBalancersIdActionsChangeProtectionRequest): Future[
    PostLoadBalancersIdActionsChangeProtectionResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the protection configuration of a Load Balancer. 
proc postLoadBalancersIdActionsChangeType(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsChangeTypeRequest): Future[
    PostLoadBalancersIdActionsChangeTypeResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the type (Max Services, Max Targets and Max Connections) of a Load
Balancer.

**Call specific error codes**

| Code                         | Description
|
|------------------------------|------------------------------------------------
-----------------|
| `invalid_load_balancer_type` | The Load Balancer type does not fit for the
given Load Balancer |
proc postLoadBalancersIdActionsDeleteService(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsDeleteServiceRequest): Future[
    PostLoadBalancersIdActionsDeleteServiceResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Delete a service of a Load Balancer. 
proc postLoadBalancersIdActionsDetachFromNetwork(client: HetznerClient;
    id: int64; body: PostLoadBalancersIdActionsDetachFromNetworkRequest): Future[
    PostLoadBalancersIdActionsDetachFromNetworkResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Detaches a Load Balancer from a network. 
proc postLoadBalancersIdActionsDisablePublicInterface(client: HetznerClient;
    id: int64): Future[PostLoadBalancersIdActionsDisablePublicInterfaceResponse] {.
    ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError,
                                LibraryError, SslError, OSError, IOError,
                                ProtocolError, KeyError, OpenParserJsonError,
                                HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Disable the public interface of a Load Balancer. The Load Balancer will be not
accessible from the internet via its public IPs.

#### Call specific error codes

| Code                                      | Description
|
|-------------------------------------------|-----------------------------------
---------------------------------------------|
| `load_balancer_not_attached_to_network`   |  The Load Balancer is not attached
to a network                                |
| `targets_without_use_private_ip`          | The Load Balancer has targets that
use the public IP instead of the private IP |
proc postLoadBalancersIdActionsEnablePublicInterface(client: HetznerClient;
    id: int64): Future[PostLoadBalancersIdActionsEnablePublicInterfaceResponse] {.
    ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError,
                                LibraryError, SslError, OSError, IOError,
                                ProtocolError, KeyError, OpenParserJsonError,
                                HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Enable the public interface of a Load Balancer. The Load Balancer will be accessible from the internet via its public IPs. 
proc postLoadBalancersIdActionsRemoveTarget(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsRemoveTargetRequest): Future[
    PostLoadBalancersIdActionsRemoveTargetResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Removes a target from a Load Balancer. 
proc postLoadBalancersIdActionsUpdateService(client: HetznerClient; id: int64;
    body: PostLoadBalancersIdActionsUpdateServiceRequest): Future[
    PostLoadBalancersIdActionsUpdateServiceResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Updates a Load Balancer Service.

#### Call specific error codes

| Code                       | Description
|
|----------------------------|--------------------------------------------------
-------|
| `source_port_already_used` | The source port you are trying to add is already
in use |

Made with Nim. Generated: 2026-08-20 03:37:01 UTC