--- title: Modifier les équilibreurs de charge réseau slug: modifier-les-equilibreurs-de-charge-reseau docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "K5mKm33EG03ryKch4_epQ", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}" } ], "name": "Modify Network Load Balancers", "description": "Modify the properties of the specified Network Load Balancer within the data center.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "datacenterId", "type": "string", "description": "The unique ID of the data center." }, { "kind": "required", "name": "networkLoadBalancerId", "type": "string", "description": "The unique ID of the Network Load Balancer." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

Controls whether the response is pretty-printed (with indentations and new lines).

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects.\nGET /datacenters/[ID]\n- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n- depth=1: Direct properties and children references are included.\n- depth=2: Direct properties and children properties are included.\n- depth=3: Direct properties and children properties and children's children are included.\n- depth=... and so on

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The modified Network Load Balancer.", "customType": "NetworkLoadBalancerPut", "schema": [ { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerProperties", "customType": "NetworkLoadBalancerProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the Network Load Balancer.", "example": "My Network Load Balancer" }, { "name": "listenerLan", "kind": "required", "type": "integer", "description": "

ID of the listening LAN (inbound).

", "example": 1 }, { "name": "ips", "kind": "optional", "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.

", "example": "[\"81.173.1.2\",\"22.231.2.2\",\"22.231.2.3\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "targetLan", "kind": "required", "type": "integer", "description": "

ID of the balanced private target LAN (outbound).

", "example": 2 }, { "name": "lbPrivateIps", "kind": "optional", "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.

", "example": "[\"81.173.1.5/24\",\"22.231.2.5/24\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "centralLogging", "kind": "optional", "type": "boolean", "description": "Turn logging on and off for this product. Default value is 'false'.", "example": true }, { "name": "loggingFormat", "kind": "optional", "type": "string", "description": "Specifies the format of the logs.", "example": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl" } ] } ], "modelRef": "#/components/schemas/NetworkLoadBalancerPut", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "202", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "NetworkLoadBalancer", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerProperties", "customType": "NetworkLoadBalancerProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the Network Load Balancer.", "example": "My Network Load Balancer" }, { "name": "listenerLan", "kind": "required", "type": "integer", "description": "

ID of the listening LAN (inbound).

", "example": 1 }, { "name": "ips", "kind": "optional", "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.

", "example": "[\"81.173.1.2\",\"22.231.2.2\",\"22.231.2.3\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "targetLan", "kind": "required", "type": "integer", "description": "

ID of the balanced private target LAN (outbound).

", "example": 2 }, { "name": "lbPrivateIps", "kind": "optional", "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.

", "example": "[\"81.173.1.5/24\",\"22.231.2.5/24\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "centralLogging", "kind": "optional", "type": "boolean", "description": "Turn logging on and off for this product. Default value is 'false'.", "example": true }, { "name": "loggingFormat", "kind": "optional", "type": "string", "description": "Specifies the format of the logs.", "example": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerEntities", "customType": "NetworkLoadBalancerEntities", "schema": [ { "name": "flowlogs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FlowLogs", "customType": "FlowLogs", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/FlowLog", "customType": "FlowLog[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/FlowLogProperties", "customType": "FlowLogProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The resource name.", "example": "My resource" }, { "name": "action", "kind": "required", "type": "string", "description": "Specifies the traffic action pattern.", "example": "ACCEPTED", "enum": [ "ACCEPTED", "REJECTED", "ALL" ] }, { "name": "direction", "kind": "required", "type": "string", "description": "Specifies the traffic direction pattern.", "example": "INGRESS", "enum": [ "INGRESS", "EGRESS", "BIDIRECTIONAL" ] }, { "name": "bucket", "kind": "required", "type": "string", "description": "The bucket name of an existing IONOS Cloud Object storage bucket.", "example": "bucketName/key" } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] }, { "name": "forwardingrules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRules", "customType": "NetworkLoadBalancerForwardingRules", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRule", "customType": "NetworkLoadBalancerForwardingRule[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRuleProperties", "customType": "NetworkLoadBalancerForwardingRuleProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The name of the Network Load Balancer forwarding rule.", "example": "My Network Load Balancer forwarding rule" }, { "name": "algorithm", "kind": "required", "type": "string", "description": "Balancing algorithm", "example": "ROUND_ROBIN", "enum": [ "ROUND_ROBIN", "LEAST_CONNECTION", "RANDOM", "SOURCE_IP" ] }, { "name": "protocol", "kind": "required", "type": "string", "description": "Balancing protocol", "example": "HTTP", "enum": [ "HTTP", "TCP" ] }, { "name": "listenerIp", "kind": "required", "type": "string", "description": "

Listening (inbound) IP.

", "example": "81.173.1.2" }, { "name": "listenerPort", "kind": "required", "type": "integer", "description": "

Listening (inbound) port number; valid range is 1 to 65535.

", "example": 8080, "format": "int32" }, { "name": "healthCheck", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRuleHealthCheck", "customType": "NetworkLoadBalancerForwardingRuleHealthCheck", "schema": [ { "name": "clientTimeout", "kind": "optional", "type": "integer", "description": "

The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).

", "example": 50, "format": "int32" }, { "name": "connectTimeout", "kind": "optional", "type": "integer", "description": "

The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds).

", "example": 5000, "format": "int32" }, { "name": "targetTimeout", "kind": "optional", "type": "integer", "description": "

The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds).

", "example": 50000, "format": "int32" }, { "name": "retries", "kind": "optional", "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.", "example": 3, "format": "int32" } ] }, { "name": "targets", "kind": "required", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRuleTarget", "customType": "NetworkLoadBalancerForwardingRuleTarget[]", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "The IP of the balanced target VM.", "example": "22.231.2.2" }, { "name": "port", "kind": "required", "type": "integer", "description": "

The port of the balanced target service; valid range is 1 to 65535.

", "example": 8080, "format": "int32" }, { "name": "weight", "kind": "required", "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.

", "example": 123, "format": "int32" }, { "name": "proxyProtocol", "kind": "optional", "type": "string", "description": "Proxy protocol version.", "example": "v1", "default": "none", "enum": [ "none", "v1", "v2", "v2ssl" ] }, { "name": "healthCheck", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NetworkLoadBalancerForwardingRuleTargetHealthCheck", "customType": "NetworkLoadBalancerForwardingRuleTargetHealthCheck", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] } ] }, { "name": "offset", "kind": "optional", "type": "number", "description": "

The offset (if specified in the request).

", "modelRef": "#/components/schemas/PaginationOffsetOptional", "customType": "PaginationOffsetOptional", "schema": [] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "prev", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.

", "example": "", "format": "uri" }, { "name": "self", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the current page.

", "example": "", "format": "uri" }, { "name": "next", "kind": "optional", "type": "string", "readOnly": true, "description": "

URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.

", "example": "", "format": "uri" } ] } ] } ] } ], "modelRef": "#/components/schemas/NetworkLoadBalancer", "isExpanded": true } ] }, { "statusCode": "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).

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "kb1sZHuA60vMmCbiMg9mO", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": {},\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"targetLan\": 2\n }\n }'" }, { "id": "f9aQPdEt2EKkgV68u8hJR", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"type\": {},\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"targetLan\": 2\n }\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WPk4qJoIyj6gASO7m6Pka", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"type\": {},\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"targetLan\": 2\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "eV2BY7JKaiQ-QoBw-WU1E", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}?pretty=true&depth=integer\"\n\npayload = json.dumps({\n \"type\": {},\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"targetLan\": 2\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "kb1sZHuA60vMmCbiMg9mO" }, "results": { "languages": [ { "id": "UxFalZ7p5fZ93ee3EBPzk", "language": "202", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My Network Load Balancer\",\n \"listenerLan\": 1,\n \"ips\": [\n \"\"\n ],\n \"targetLan\": 2,\n \"lbPrivateIps\": [\n \"\"\n ],\n \"centralLogging\": true,\n \"loggingFormat\": \"%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \\\"\\\" \\\"\\\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl\"\n },\n \"entities\": {\n \"flowlogs\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My resource\",\n \"action\": \"ACCEPTED\",\n \"direction\": \"INGRESS\",\n \"bucket\": \"bucketName/key\"\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n },\n \"forwardingrules\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My Network Load Balancer forwarding rule\",\n \"algorithm\": \"ROUND_ROBIN\",\n \"protocol\": \"HTTP\",\n \"listenerIp\": \"81.173.1.2\",\n \"listenerPort\": 8080,\n \"healthCheck\": {\n \"clientTimeout\": 50,\n \"connectTimeout\": 5000,\n \"targetTimeout\": 50000,\n \"retries\": 3\n },\n \"targets\": [\n {\n \"ip\": \"22.231.2.2\",\n \"port\": 8080,\n \"weight\": 123,\n \"proxyProtocol\": \"v1\",\n \"healthCheck\": {\n \"\": \"\"\n }\n }\n ]\n }\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"prev\": \"\",\n \"self\": \"\",\n \"next\": \"\"\n }\n }\n }\n}" }, { "id": "Xuq3JwfuObGXWTPs5fwdk", "language": "default", "code": "// 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).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "UxFalZ7p5fZ93ee3EBPzk" } }, "children": [ { "text": "", "id": "U6SQvd9zgJpJuvL1Plcgf" } ] }