{ "opencollection": "1.0.0", "info": { "name": "Hetzner Cloud Actions Load Balancer Actions API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Load Balancer Actions", "type": "folder" }, "items": [ { "info": { "name": "List Actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/load_balancers/actions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter the actions by ID. May be used multiple times.\n\nThe response will only contain actions matching the specified IDs.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` and `id` parameter.\n" }, { "info": { "name": "Get an Action", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/load_balancers/actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a specific Action object.\n" }, { "info": { "name": "List Actions for a Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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.\n" }, { "info": { "name": "Add Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/add_service", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Adds a service to a Load Balancer.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `412` | `source_port_already_used` | The source port you are trying to add is already in use |\n" }, { "info": { "name": "Add Target", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/add_target", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Adds a target to a Load Balancer.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `ip_not_in_vswitch_subnet` | The IP you are trying to add does not belong to the vswitch subnet of the attached network |\n| `422` | `ip_not_owned` | The IP you are trying to add as a target is not owned by the Project owner |\n| `422` | `load_balancer_public_interface_disabled` | The Load Balancer's public network interface is disabled |\n| `422` | `load_balancer_not_att" }, { "info": { "name": "Attach a Load Balancer to a Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/attach_to_network", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Attach a Load Balancer to a Network.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `load_balancer_already_attached` | The Load Balancer is already attached to a network |\n| `422` | `ip_not_available` | The provided Network IP is not available |\n| `422` | `no_subnet_available` | No Subnet or IP is available for the Load Balancer within the network |\n" }, { "info": { "name": "Change Algorithm", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/change_algorithm", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Change the algorithm that determines to which target new requests are sent.\n" }, { "info": { "name": "Change reverse DNS entry for this Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/change_dns_ptr", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the hostname that will appear when getting the hostname belonging to the public IPs (IPv4 and IPv6) of this Load Balancer.\n\nFloating IPs assigned to the Server are not affected by this.\n" }, { "info": { "name": "Change Load Balancer Protection", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/change_protection", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the protection configuration of a Load Balancer.\n" }, { "info": { "name": "Change the Type of a Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/change_type", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Changes the type (Max Services, Max Targets and Max Connections) of a Load Balancer.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `invalid_load_balancer_type` | The Load Balancer type does not fit for the given Load Balancer |\n" }, { "info": { "name": "Delete Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/delete_service", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a service of a Load Balancer.\n" }, { "info": { "name": "Detach a Load Balancer from a Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/detach_from_network", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Detaches a Load Balancer from a network.\n" }, { "info": { "name": "Disable the public interface of a Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/disable_public_interface", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Disable the public interface of a Load Balancer. The Load Balancer will be not accessible from the internet via its public IPs.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `load_balancer_not_attached_to_network` | The Load Balancer is not attached to a network |\n| `422` | `targets_without_use_private_ip` | The Load Balancer has targets that use the public IP instead of the private IP |\n" }, { "info": { "name": "Enable the public interface of a Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/enable_public_interface", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enable the public interface of a Load Balancer. The Load Balancer will be accessible from the internet via its public IPs.\n" }, { "info": { "name": "Remove Target", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/remove_target", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Removes a target from a Load Balancer.\n" }, { "info": { "name": "Update Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/update_service", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates a Load Balancer Service.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `422` | `source_port_already_used` | The source port you are trying to add is already in use |\n" }, { "info": { "name": "Get an Action for a Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/load_balancers/:id/actions/:action_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Load Balancer." }, { "name": "action_id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "**Deprecated**: This operation is deprecated, see our [changelog](https://docs.hetzner.cloud/changelog#2026-04-30-deprecate-get-resource-action-endpoints) for more details.\n\nReturns a specific Action for a Load Balancer.\n" } ] } ], "bundled": true }