Types
GetNetworksIdActionsActionIdResponse = object
GetNetworksIdActionsResponse = object
NetworkActionSortOption = 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"
NetworkActionStatusOption = enum statusRunning = "running", statusSuccess = "success", statusError = "error"
Procs
proc getNetworksIdActions(client: HetznerClient; id: int64; sort: set[NetworkActionSortOption] = {}; status: set[NetworkActionStatusOption] = {}): Future[ GetNetworksIdActionsResponse] {....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 Network. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
proc getNetworksIdActionsActionId(client: HetznerClient; id: int64; actionId: int64): Future[ GetNetworksIdActionsActionIdResponse] {....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 Network.
proc postNetworksIdActionsAddRoute(client: HetznerClient; id: int64; body: PostNetworksIdActionsAddRouteRequest): Future[ PostNetworksIdActionsAddRouteResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Adds a route entry to a Network.
Note: if the Network object changes during the request, the response will be a “conflict” error.
proc postNetworksIdActionsAddSubnet(client: HetznerClient; id: int64; body: PostNetworksIdActionsAddSubnetRequest): Future[ PostNetworksIdActionsAddSubnetResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Adds a new subnet object to the Network. If you do not specify an ip_range for the subnet we will automatically pick the first available /24 range for you if possible.
Note: if the parent Network object changes during the request, the response will be a “conflict” error.
proc postNetworksIdActionsChangeIpRange(client: HetznerClient; id: int64; body: PostNetworksIdActionsChangeIpRangeRequest): Future[ PostNetworksIdActionsChangeIpRangeResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Changes the IP range of a Network. IP ranges can only be extended and never shrunk. You can only add IPs at the end of an existing IP range. This means that the IP part of your existing range must stay the same and you can only change its netmask.
For example if you have a range 10.0.0.0/16 you want to extend then your new range must also start with the IP 10.0.0.0. Your CIDR netmask /16 may change to a number that is smaller than 16 thereby increasing the IP range. So valid entries would be 10.0.0.0/15, 10.0.0.0/14, 10.0.0.0/13 and so on.
After changing the IP range you will have to adjust the routes on your connected Servers by either rebooting them or manually changing the routes to your private Network interface.
Note: if the Network object changes during the request, the response will be a “conflict” error.
proc postNetworksIdActionsChangeProtection(client: HetznerClient; id: int64; body: PostNetworksIdActionsChangeProtectionRequest): Future[ PostNetworksIdActionsChangeProtectionResponse] {....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 Network.
Note: if the Network object changes during the request, the response will be a “conflict” error.
proc postNetworksIdActionsDeleteRoute(client: HetznerClient; id: int64; body: PostNetworksIdActionsDeleteRouteRequest): Future[ PostNetworksIdActionsDeleteRouteResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Delete a route entry from a Network.
Note: if the Network object changes during the request, the response will be a “conflict” error.
proc postNetworksIdActionsDeleteSubnet(client: HetznerClient; id: int64; body: PostNetworksIdActionsDeleteSubnetRequest): Future[ PostNetworksIdActionsDeleteSubnetResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Deletes a single subnet entry from a Network. You cannot delete subnets which still have Servers attached. If you have Servers attached you first need to detach all Servers that use IPs from this subnet before you can delete the subnet.
Note: if the Network object changes during the request, the response will be a “conflict” error.