> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/api-reference/cloud-api-v6/network-load-balancers/modify-network-load-balancers.md). # Modify Network Load Balancers Modify the properties of the specified Network Load Balancer within the data center. ```json {"openapi":"3.0.3","info":{"title":"CLOUD API","version":"6.0"},"tags":[{"name":"Network Load Balancers"}],"servers":[{"url":"https://api.ionos.com/cloudapi/v6"}],"security":[{"BasicAuthentication":[]},{"TokenAuthentication":[]}],"components":{"securitySchemes":{"BasicAuthentication":{"type":"http","description":"You will need to base64 encode the string containing your credentials.
\n Note:

\n
Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication","scheme":"basic"},"TokenAuthentication":{"type":"apiKey","description":"Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.","name":"Authorization","in":"header"}},"schemas":{"NetworkLoadBalancerPut":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"properties":{"$ref":"#/components/schemas/NetworkLoadBalancerProperties"}}},"Type":{"type":"string","enum":["datacenter","server","volume","nic","loadbalancer","location","firewall-rule","flow-log","image","snapshot","lan","ipblock","pcc","contract","user","group","collection","resource","request","request-status","s3key","backupunit","label","k8s","nodepool","template","networkloadbalancer","forwarding-rule","natgateway","natgateway-rule","node","applicationloadbalancer","target-group","security-group","gpu"]},"NetworkLoadBalancerProperties":{"required":["listenerLan","name","targetLan"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Network Load Balancer."},"listenerLan":{"type":"integer","description":"ID of the listening LAN (inbound)."},"ips":{"type":"array","description":"Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers.","items":{"type":"string"}},"targetLan":{"type":"integer","description":"ID of the balanced private target LAN (outbound)."},"lbPrivateIps":{"type":"array","description":"Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.","items":{"type":"string"}},"centralLogging":{"type":"boolean","description":"Turn logging on and off for this product. Default value is 'false'."},"loggingFormat":{"type":"string","description":"Specifies the format of the logs."},"tier":{"type":"string","description":"The service tier the Network Load Balancer runs on. See `VnfServiceTier`.","allOf":[{"$ref":"#/components/schemas/VnfServiceTier"}]},"maintenanceWindow":{"nullable":true,"description":"The weekly slot in which IONOS may carry out disruptive work on this Network Load Balancer. Sending `null` clears a configured window, after which the resource follows the assignment rule again. See `VnfMaintenanceWindow`.","allOf":[{"$ref":"#/components/schemas/VnfMaintenanceWindow"}]}}},"VnfServiceTier":{"type":"string","description":"The service tiers a VNF resource can run on. Each names a performance class and a redundancy; the `_HA` suffix marks the redundant form, and both dimensions are compared by the upgrade-only rule below. What a tier resolves to in cores, memory and machine type is defined per product and is the same in every location.\n\n**Which tiers are accepted.** A tier the product's catalogue holds no entry for is refused, since nothing then defines what it resolves to. `STANDARD_HA` is the exception and is accepted whether or not the catalogue holds an entry for it; where it holds none, the resource is sized by the platform's own configuration for that product rather than by a catalogue entry.\n\n**Upgrades only.** A change that lowers either the performance class or the redundancy of the tier the resource is running is rejected.\n\n**Selecting a tier.** Naming a tier that differs from the one the resource is running, or on creation naming one other than the tier it would receive anyway, is a selection. A selection requires service tiers to be enabled on both the contract and the cluster, and is refused if either is not. Naming the tier a resource is already running is not a selection and is always accepted, so a resource that has been read can be written back without the feature enabled. Creating a resource on the tier it would receive anyway is likewise not a selection, so a client may equally create one from a resource it has read.\n\n**When a selection takes effect.** At once. Nothing is queued and nothing waits for the resource's maintenance window, so a resource's `tier` reports the tier it is running and never one it is moving to.\n\n**Omitting the tier.** On creation a resource starts on the tier configured as the default for its product, where service tiers are enabled on both the contract and the cluster; otherwise, and where the catalogue marks no default, it starts on `STANDARD_HA`. On update the resource keeps the tier it is running — an omitted tier is never read as a request to return to the default.\n\n**An open set.** The set of tiers may grow, so a client generated against this spec must tolerate a tier it does not recognise rather than fail on it. A tier this API does not yet define is still refused on write: an open set describes what a client may one day be told, not what it may send."},"VnfMaintenanceWindow":{"required":["dayOfTheWeek","time"],"type":"object","description":"The weekly slot in which IONOS may carry out disruptive work on a VNF resource. Set the window that suits you: it is recorded so that IONOS operations know when they may intervene on the resource, and the platform itself never acts on the stored value — no change to the resource is held back waiting for the window to open, and none is applied because it opened. Changing the window does not itself reprovision the resource.\n\n**A window is a span, not an instant.** It opens at the stated time and stays open for a fixed length, configured by the platform and the same for every resource; work may begin at any point while it is open.\n\n**Every resource has one at all times.** When none is configured, the system assigns one derived from the resource's identifier, which spreads assigned windows across the week instead of gathering every resource into one slot.\n\n**Setting and clearing.** Omitting the window when updating an existing resource leaves the window it already has unchanged. Sending it as `null` clears it, after which the resource follows the assignment rule again. Clearing is the way back for a resource that carries a window nobody chose for it — a copied data centre gives each copy the window of the resource it was copied from, because the copy states the window it was shown. The schemas that carry this window serve requests and responses alike, so the contract admits `null` in both; what the platform returns is always a window, configured or assigned.","properties":{"dayOfTheWeek":{"type":"string","description":"The weekday for a maintenance window.","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]},"time":{"type":"string","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-](0[0-9]|1[0-4])[0-5][0-9])?$","description":"The time of day the maintenance window opens, as a UTC wall-clock time. Accepted formats are `HH:mm:ss`, `HH:mm:ssZ`, and `HH:mm:ss±hhmm` with the offset written without a colon — an offset in the `±hh:mm` form is rejected. An offset that is given is accepted but **not applied**: the time is taken as stated and evaluated in UTC, so `13:00:00+0200` opens the window at 13:00 UTC and not at 11:00 UTC. Send the value already converted to UTC. Responses always report the bare `HH:mm:ss` form."}}},"NetworkLoadBalancer":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NetworkLoadBalancerProperties"},"entities":{"$ref":"#/components/schemas/NetworkLoadBalancerEntities"}}},"DatacenterElementMetadata":{"type":"object","properties":{"etag":{"type":"string","description":"Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.","readOnly":true},"createdDate":{"type":"string","description":"The last time the resource was created.","format":"date-time","readOnly":true},"createdBy":{"type":"string","description":"The user who created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","description":"The last time the resource was modified.","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","description":"The user who last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"state":{"type":"string","description":"State of the resource. *AVAILABLE* There are no pending modification requests for this item; *BUSY* There is at least one modification request pending and all following requests will be queued; *INACTIVE* Resource has been de-provisioned; *DEPLOYING* Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; *ACTIVE* Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; *FAILED* Resource state FAILED - relevant for Kubernetes cluster/nodepool; *SUSPENDED* Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; *FAILED_SUSPENDED* Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; *UPDATING* Resource state UPDATING - relevant for Kubernetes cluster/nodepool; *FAILED_UPDATING* Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; *DESTROYING* Resource state DESTROYING - relevant for Kubernetes cluster; *FAILED_DESTROYING* Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; *TERMINATED* Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; *HIBERNATING* Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; *FAILED_HIBERNATING* Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; *MAINTENANCE* Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; *FAILED_HIBERNATING* Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.","readOnly":true,"enum":["AVAILABLE","INACTIVE","BUSY","DEPLOYING","ACTIVE","FAILED","SUSPENDED","FAILED_SUSPENDED","UPDATING","FAILED_UPDATING","DESTROYING","FAILED_DESTROYING","TERMINATED","HIBERNATING","FAILED_HIBERNATING","MAINTENANCE","FAILED_MAINTENANCE","UNKNOWN"]}}},"NetworkLoadBalancerEntities":{"type":"object","properties":{"flowlogs":{"$ref":"#/components/schemas/FlowLogs"},"forwardingrules":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRules"}}},"FlowLogs":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/FlowLog"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowLog":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/FlowLogProperties"}}},"FlowLogProperties":{"required":["action","bucket","direction","name"],"type":"object","properties":{"name":{"type":"string","description":"The resource name."},"action":{"type":"string","description":"Specifies the traffic action pattern.","enum":["ACCEPTED","REJECTED","ALL"]},"direction":{"type":"string","description":"Specifies the traffic direction pattern.","enum":["INGRESS","EGRESS","BIDIRECTIONAL"]},"bucket":{"type":"string","description":"The bucket name of an existing IONOS CLOUD Object storage bucket."}}},"PaginationOffsetOptional":{"type":"number","description":"The offset (if specified in the request)."},"PaginationLimitOptional":{"type":"number","description":"The limit (if specified in the request)."},"PaginationLinks":{"type":"object","properties":{"prev":{"type":"string","description":"URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.","format":"uri","readOnly":true},"self":{"type":"string","description":"URL (with offset and limit parameters) of the current page.","format":"uri","readOnly":true},"next":{"type":"string","description":"URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.","format":"uri","readOnly":true}}},"NetworkLoadBalancerForwardingRules":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRule"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"NetworkLoadBalancerForwardingRule":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleProperties"}}},"NetworkLoadBalancerForwardingRuleProperties":{"required":["algorithm","listenerIp","listenerPort","name","protocol","targets"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Network Load Balancer forwarding rule."},"algorithm":{"type":"string","description":"Balancing algorithm","enum":["ROUND_ROBIN","LEAST_CONNECTION","RANDOM","SOURCE_IP"]},"protocol":{"type":"string","description":"Balancing protocol","enum":["HTTP","TCP"]},"listenerIp":{"type":"string","description":"Listening (inbound) IP."},"listenerPort":{"type":"integer","description":"Listening (inbound) port number; valid range is 1 to 65535.","format":"int32"},"healthCheck":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleHealthCheck"},"targets":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleTarget"}}}},"NetworkLoadBalancerForwardingRuleHealthCheck":{"type":"object","properties":{"clientTimeout":{"type":"integer","description":"The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).","format":"int32"},"connectTimeout":{"type":"integer","description":"The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds).","format":"int32"},"targetTimeout":{"type":"integer","description":"The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds).","format":"int32"},"retries":{"type":"integer","description":"The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535 and default is three reconnection attempts.","format":"int32"}}},"NetworkLoadBalancerForwardingRuleTarget":{"required":["ip","port","weight"],"type":"object","properties":{"ip":{"type":"string","description":"The IP of the balanced target VM."},"port":{"type":"integer","description":"The port of the balanced target service; valid range is 1 to 65535.","format":"int32"},"weight":{"type":"integer","description":"Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1. Targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best to assign weights in the middle of the range to leave room for later adjustments.","format":"int32"},"proxyProtocol":{"type":"string","description":"Proxy protocol version.","default":"none","enum":["none","v1","v2","v2ssl"]},"healthCheck":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleTargetHealthCheck"}}},"NetworkLoadBalancerForwardingRuleTargetHealthCheck":{"type":"object","properties":{"check":{"type":"boolean","description":"Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target."},"checkInterval":{"type":"integer","description":"The interval in milliseconds between consecutive health checks; default is 2000.","format":"int32"},"maintenance":{"type":"boolean","description":"Maintenance mode prevents the target from receiving balanced traffic."}}},"Error":{"type":"object","properties":{"httpStatus":{"type":"integer","description":"HTTP status code of the operation.","format":"int32","readOnly":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string","description":"Application internal error code.","readOnly":true},"message":{"type":"string","description":"A human-readable message.","readOnly":true}}}}},"paths":{"/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}":{"put":{"tags":["Network Load Balancers"],"summary":"Modify Network Load Balancers","description":"Modify the properties of the specified Network Load Balancer within the data center.","operationId":"datacentersNetworkloadbalancersPut","parameters":[{"name":"datacenterId","in":"path","description":"The unique ID of the data center.","required":true,"schema":{"type":"string"}},{"name":"networkLoadBalancerId","in":"path","description":"The unique ID of the Network Load Balancer.","required":true,"schema":{"type":"string"}},{"name":"pretty","in":"query","description":"Controls whether the response is pretty-printed (with indentations and new lines).","schema":{"type":"boolean","default":true}},{"name":"depth","in":"query","description":"Controls the detail depth of the response objects. \nGET /datacenters/[ID]\n\t- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n\t- depth=1: Direct properties and children references are included.\n\t- depth=2: Direct properties and children properties are included.\n\t- depth=3: Direct properties and children properties and children's children are included.\n\t- depth=... and so on","schema":{"maximum":10,"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"X-Contract-Number","in":"header","description":"Users with multiple contracts must provide the contract number, for which all API requests are to be executed.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The modified Network Load Balancer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkLoadBalancerPut"}}},"required":true},"responses":{"202":{"description":"Successful operation","headers":{"X-RateLimit-Remaining":{"description":"The number of requests that can still be made without triggering a failure response.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Limit":{"description":"The average number of requests per minute allowed.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Burst":{"description":"The maximum number of concurrent API requests allowed.","schema":{"type":"integer","format":"int32"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkLoadBalancer"}}}},"default":{"description":"Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/api-reference/cloud-api-v6/network-load-balancers/modify-network-load-balancers.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.