--- title: Créer un équilibreur de charge slug: creer-un-equilibreur-de-charge docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "3WgWQ0U9_l9DETIoDWrrD", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers" } ], "name": "Create a Load Balancer", "description": "Creates a 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." } ], "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 Load Balancer to create.", "customType": "Loadbalancer", "schema": [ { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "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/LoadbalancerProperties", "customType": "LoadbalancerProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "ip", "kind": "optional", "type": "string", "nullable": true, "description": "IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically.", "example": "22.231.113.64" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the loadbalancer will reserve an IP using DHCP.", "example": true } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LoadbalancerEntities", "customType": "LoadbalancerEntities", "schema": [ { "name": "balancednics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BalancedNics", "customType": "BalancedNics", "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/Nic", "customType": "Nic[]", "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/NicProperties", "customType": "NicProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "mac", "kind": "optional", "type": "string", "description": "The MAC address of the NIC.", "example": "00:0a:95:9d:68:16" }, { "name": "ips", "kind": "optional", "type": "array", "nullable": true, "description": "

Collection of IP addresses, assigned to the NIC. Explicitly assigned public IPs need to come from reserved IP blocks. Passing value null or empty array will assign an IP address automatically.

", "example": "[\"10.160.12.12\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the NIC will reserve an IP using DHCP.", "example": true, "default": true }, { "name": "ipv6Ips", "kind": "optional", "type": "array", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the IPv6 IP addresses of the NIC. The maximum number of IPv6 IP addresses per NIC is 50, if you need more, contact support. If you leave this property 'null' when adding a NIC, when changing the NIC's IPv6 CIDR block, when changing the LAN's IPv6 CIDR block or when moving the NIC to a different IPv6 enabled LAN, then we will automatically assign the same number of IPv6 addresses which you had before from the NICs new CIDR block. If you leave this property 'null' while not changing the CIDR block, the IPv6 IP addresses won't be changed either. You can also provide your own self choosen IPv6 addresses, which then must be inside the IPv6 CIDR block of this NIC.

", "example": "[\"2001:db8:b06d:8f5a:0609::1\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "ipv6CidrBlock", "kind": "optional", "type": "string", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the /80 IPv6 CIDR block of the NIC. If you leave this property 'null' when adding a NIC to an IPv6-enabled LAN, then an IPv6 CIDR block will automatically be assigned to the NIC, but you can also specify an /80 IPv6 CIDR block for the NIC on your own, which must be inside the /64 IPv6 CIDR block of the LAN and unique. This value can only be set, if the LAN already has an IPv6 CIDR block assigned. An IPv6-enabled LAN is limited to a maximum of 65,536 NICs.

", "example": "2001:db8:b06d:8f5a:0609::/80" }, { "name": "dhcpv6", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if the NIC will receive an IPv6 using DHCP. It can be set to 'true' or 'false' only if this NIC is connected to an IPv6 enabled LAN.", "example": true, "default": true }, { "name": "lan", "kind": "required", "type": "integer", "description": "

The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.

", "example": 2, "format": "int32" }, { "name": "firewallActive", "kind": "optional", "type": "boolean", "description": "

Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports.

", "example": false }, { "name": "firewallType", "kind": "optional", "type": "string", "description": "

The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.

", "example": "INGRESS", "enum": [ "INGRESS", "EGRESS", "BIDIRECTIONAL" ] }, { "name": "deviceNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter.

", "example": 3, "format": "int32" }, { "name": "pciSlot", "kind": "optional", "type": "integer", "readOnly": true, "description": "The PCI slot number for the NIC.", "example": 7, "format": "int32" }, { "name": "vnet", "kind": "optional", "type": "string", "description": "

The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only

", "example": "" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NicEntities", "customType": "NicEntities", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "firewallrules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FirewallRules", "customType": "FirewallRules", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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/FirewallRule", "customType": "FirewallRule[]", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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/SecurityGroup", "customType": "SecurityGroup[]", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "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/Loadbalancer", "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" }, { "kind": "optional", "name": "Location", "type": "string", "description": "Callback URL to poll async operation status.", "pattern": "https://[apiBaseUri]/requests/[requestId]/status" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Loadbalancer", "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/LoadbalancerProperties", "customType": "LoadbalancerProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "ip", "kind": "optional", "type": "string", "nullable": true, "description": "IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically.", "example": "22.231.113.64" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the loadbalancer will reserve an IP using DHCP.", "example": true } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LoadbalancerEntities", "customType": "LoadbalancerEntities", "schema": [ { "name": "balancednics", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BalancedNics", "customType": "BalancedNics", "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/Nic", "customType": "Nic[]", "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/NicProperties", "customType": "NicProperties", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "The name of the resource.", "example": "My resource" }, { "name": "mac", "kind": "optional", "type": "string", "description": "The MAC address of the NIC.", "example": "00:0a:95:9d:68:16" }, { "name": "ips", "kind": "optional", "type": "array", "nullable": true, "description": "

Collection of IP addresses, assigned to the NIC. Explicitly assigned public IPs need to come from reserved IP blocks. Passing value null or empty array will assign an IP address automatically.

", "example": "[\"10.160.12.12\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "dhcp", "kind": "optional", "type": "boolean", "description": "Indicates if the NIC will reserve an IP using DHCP.", "example": true, "default": true }, { "name": "ipv6Ips", "kind": "optional", "type": "array", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the IPv6 IP addresses of the NIC. The maximum number of IPv6 IP addresses per NIC is 50, if you need more, contact support. If you leave this property 'null' when adding a NIC, when changing the NIC's IPv6 CIDR block, when changing the LAN's IPv6 CIDR block or when moving the NIC to a different IPv6 enabled LAN, then we will automatically assign the same number of IPv6 addresses which you had before from the NICs new CIDR block. If you leave this property 'null' while not changing the CIDR block, the IPv6 IP addresses won't be changed either. You can also provide your own self choosen IPv6 addresses, which then must be inside the IPv6 CIDR block of this NIC.

", "example": "[\"2001:db8:b06d:8f5a:0609::1\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "ipv6CidrBlock", "kind": "optional", "type": "string", "nullable": true, "description": "

If this NIC is connected to an IPv6 enabled LAN then this property contains the /80 IPv6 CIDR block of the NIC. If you leave this property 'null' when adding a NIC to an IPv6-enabled LAN, then an IPv6 CIDR block will automatically be assigned to the NIC, but you can also specify an /80 IPv6 CIDR block for the NIC on your own, which must be inside the /64 IPv6 CIDR block of the LAN and unique. This value can only be set, if the LAN already has an IPv6 CIDR block assigned. An IPv6-enabled LAN is limited to a maximum of 65,536 NICs.

", "example": "2001:db8:b06d:8f5a:0609::/80" }, { "name": "dhcpv6", "kind": "optional", "type": "boolean", "nullable": true, "description": "Indicates if the NIC will receive an IPv6 using DHCP. It can be set to 'true' or 'false' only if this NIC is connected to an IPv6 enabled LAN.", "example": true, "default": true }, { "name": "lan", "kind": "required", "type": "integer", "description": "

The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.

", "example": 2, "format": "int32" }, { "name": "firewallActive", "kind": "optional", "type": "boolean", "description": "

Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports.

", "example": false }, { "name": "firewallType", "kind": "optional", "type": "string", "description": "

The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.

", "example": "INGRESS", "enum": [ "INGRESS", "EGRESS", "BIDIRECTIONAL" ] }, { "name": "deviceNumber", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter.

", "example": 3, "format": "int32" }, { "name": "pciSlot", "kind": "optional", "type": "integer", "readOnly": true, "description": "The PCI slot number for the NIC.", "example": 7, "format": "int32" }, { "name": "vnet", "kind": "optional", "type": "string", "description": "

The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only

", "example": "" } ] }, { "name": "entities", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/NicEntities", "customType": "NicEntities", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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": "", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "firewallrules", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/FirewallRules", "customType": "FirewallRules", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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/FirewallRule", "customType": "FirewallRule[]", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "securitygroups", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SecurityGroups", "customType": "SecurityGroups", "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": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ], "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/SecurityGroup", "customType": "SecurityGroup[]", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "limit", "kind": "optional", "type": "number", "description": "

The limit (if specified in the request).

", "example": 1000, "modelRef": "#/components/schemas/PaginationLimitOptional", "customType": "PaginationLimitOptional", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "_links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PaginationLinks", "customType": "PaginationLinks", "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/Loadbalancer", "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": "b05bPSM6kxnru59PuS4lo", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"type\": {},\n \"properties\": {},\n \"entities\": {\n \"balancednics\": {\n \"type\": {},\n \"items\": [\n {\n \"type\": {},\n \"properties\": {\n \"dhcp\": true,\n \"dhcpv6\": true,\n \"lan\": 2\n }\n }\n ]\n }\n }\n }'" }, { "id": "VbtBqNYliQLsoHGloT9Js", "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 \"entities\": {\n \"balancednics\": {\n \"type\": {},\n \"items\": [\n {\n \"type\": {},\n \"properties\": {\n \"dhcp\": true,\n \"dhcpv6\": true,\n \"lan\": 2\n }\n }\n ]\n }\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "VYYsIRU8hBNjOZ_FpfV7i", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"type\": {},\n \"properties\": {},\n \"entities\": {\n \"balancednics\": {\n \"type\": {},\n \"items\": [\n {\n \"type\": {},\n \"properties\": {\n \"dhcp\": true,\n \"dhcpv6\": true,\n \"lan\": 2\n }\n }\n ]\n }\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "oxokmzsBs1KqoGPNPK5jL", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer\"\n\npayload = json.dumps({\n \"type\": {},\n \"properties\": {},\n \"entities\": {\n \"balancednics\": {\n \"type\": {},\n \"items\": [\n {\n \"type\": {},\n \"properties\": {\n \"dhcp\": True,\n \"dhcpv6\": True,\n \"lan\": 2\n }\n }\n ]\n }\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "b05bPSM6kxnru59PuS4lo" }, "results": { "languages": [ { "id": "-Va7Ocf7Nl8ljb5pbW3o8", "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 resource\",\n \"ip\": \"22.231.113.64\",\n \"dhcp\": true\n },\n \"entities\": {\n \"balancednics\": {\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 \"mac\": \"00:0a:95:9d:68:16\",\n \"ips\": [\n \"\"\n ],\n \"dhcp\": true,\n \"ipv6Ips\": [\n \"\"\n ],\n \"ipv6CidrBlock\": \"2001:db8:b06d:8f5a:0609::/80\",\n \"dhcpv6\": true,\n \"lan\": 2,\n \"firewallActive\": false,\n \"firewallType\": \"INGRESS\",\n \"deviceNumber\": 3,\n \"pciSlot\": 7,\n \"vnet\": \"\"\n },\n \"entities\": {\n \"flowlogs\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"firewallrules\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\n \"\": \"\"\n }\n },\n \"securitygroups\": {\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"items\": [\n {\n \"\": \"\"\n }\n ],\n \"offset\": 0,\n \"limit\": 1000,\n \"_links\": {\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": "J9Leukch8nGdPqwUTcKnO", "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": "-Va7Ocf7Nl8ljb5pbW3o8" } }, "children": [ { "text": "", "id": "TFAZN-BhxizutHcED-3Po" } ] }