List Load Balancers

1 min

GET

https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers

List all the Load Balancers within the data center.

Path Parameters

datacenterIdstringrequired
Description
The unique ID of the data center.

Query Parameters

prettyboolean
Description
Controls whether the response is pretty-printed (with indentations and new lines).
Default
true
depthinteger<int32>
Description
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
Default
0
Format
int32
Minimum
0
Maximum
10
offsetinteger<int32>
Description
The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).
Default
0
Format
int32
Minimum
0
limitinteger<int32>
Description
The maximum number of elements to return (use together with offset for pagination).
Default
1000
Format
int32
Minimum
1
Maximum
10000

Header Parameters

X-Contract-Numberinteger<int32>
Description
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Format
int32

Responses

200Successful operation

Loadbalancers
- idstring
  Example
  15f67991-0f51-4efc-a8ad-ef1fb31a480c
  Description
  The resource's unique identifier.
- typeobject
  - Type
- hrefstring<uri>
  Example
  <RESOURCE-URI>
  Description
  URL to the object representation (absolute path).
  Format
  uri
- itemsLoadbalancer[]
  Description
  Array of items in the collection.
  - idstring
    Example
    15f67991-0f51-4efc-a8ad-ef1fb31a480c
    Description
    The resource's unique identifier.
  - typeobject
    - Type
  - hrefstring<uri>
    Example
    <RESOURCE-URI>
    Description
    URL to the object representation (absolute path).
    Format
    uri
  - metadataDatacenterElementMetadata
    - etagstring
      Example
      45480eb3fbfc31f1d916c1eaa4abdcc3
      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.
    - createdDatestring<date-time>
      Example
      2015-12-04T14:34:09.809Z
      Description
      The last time the resource was created.
      Format
      date-time
    - createdBystring
      Example
      [email protected]
      Description
      The user who created the resource.
    - createdByUserIdstring
      Example
      [email protected]
      Description
      The unique ID of the user who created the resource.
    - lastModifiedDatestring<date-time>
      Example
      2015-12-04T14:34:09.809Z
      Description
      The last time the resource was modified.
      Format
      date-time
    - lastModifiedBystring
      Example
      [email protected]
      Description
      The user who last modified the resource.
    - lastModifiedByUserIdstring
      Example
      63cef532-26fe-4a64-a4e0-de7c8a506c90
      Description
      The unique ID of the user who last modified the resource.
    - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
      Example
      AVAILABLE
      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.
      Allowed
      AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
  - propertiesLoadbalancerPropertiesrequired
    - namestring
      Example
      My resource
      Description
      The name of the resource.
    - ipstring
      Example
      22.231.113.64
      Description
      IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically.
    - dhcpboolean
      Example
      true
      Description
      Indicates if the loadbalancer will reserve an IP using DHCP.
  - entitiesLoadbalancerEntities
    - balancednicsBalancedNics
      - idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
      - typeobject
        Type
      - hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
      - itemsNic[]
        Description
        Array of items in the collection.
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
        metadataDatacenterElementMetadata
        etagstring
        Example
        45480eb3fbfc31f1d916c1eaa4abdcc3
        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.
        createdDatestring<date-time>
        Example
        2015-12-04T14:34:09.809Z
        Description
        The last time the resource was created.
        Format
        date-time
        createdBystring
        Example
        [email protected]
        Description
        The user who created the resource.
        createdByUserIdstring
        Example
        [email protected]
        Description
        The unique ID of the user who created the resource.
        lastModifiedDatestring<date-time>
        Example
        2015-12-04T14:34:09.809Z
        Description
        The last time the resource was modified.
        Format
        date-time
        lastModifiedBystring
        Example
        [email protected]
        Description
        The user who last modified the resource.
        lastModifiedByUserIdstring
        Example
        63cef532-26fe-4a64-a4e0-de7c8a506c90
        Description
        The unique ID of the user who last modified the resource.
        statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
        Example
        AVAILABLE
        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.
        Allowed
        AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
        propertiesNicPropertiesrequired
        namestring
        Example
        My resource
        Description
        The name of the resource.
        macstring
        Example
        00:0a:95:9d:68:16
        Description
        The MAC address of the NIC.
        ipsstring[]
        Example
        [ "10.160.12.12" ]
        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.
        dhcpboolean
        Example
        true
        Description
        Indicates if the NIC will reserve an IP using DHCP.
        Default
        true
        ipv6Ipsstring[]
        Example
        [ "2001:db8:b06d:8f5a:0609::1" ]
        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.
        ipv6CidrBlockstring
        Example
        2001:db8:b06d:8f5a:0609::/80
        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.
        dhcpv6boolean
        Example
        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.
        Default
        true
        laninteger<int32>required
        Example
        2
        Description
        The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.
        Format
        int32
        firewallActiveboolean
        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.
        firewallTypestring<INGRESS | EGRESS | BIDIRECTIONAL>
        Example
        INGRESS
        Description
        The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.
        Allowed
        INGRESSEGRESSBIDIRECTIONAL
        deviceNumberinteger<int32>
        Example
        3
        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.
        Format
        int32
        pciSlotinteger<int32>
        Example
        7
        Description
        The PCI slot number for the NIC.
        Format
        int32
        vnetstring
        Description
        The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only
        entitiesNicEntities
        flowlogsFlowLogs
        Max depth limit reached
        firewallrulesFirewallRules
        Max depth limit reached
        securitygroupsSecurityGroups
        Max depth limit reached
      - offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
      - limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
      - _linksPaginationLinks
        prevstring<uri>
        Example
        <PREVIOUS-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.
        Format
        uri
        selfstring<uri>
        Example
        <THIS-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the current page.
        Format
        uri
        nextstring<uri>
        Example
        <NEXT-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.
        Format
        uri
- offsetPaginationOffsetOptional
  Description
  The offset (if specified in the request).
- limitPaginationLimitOptional
  Example
  1000
  Description
  The limit (if specified in the request).
- _linksPaginationLinks
  - prevstring<uri>
    Example
    <PREVIOUS-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.
    Format
    uri
  - selfstring<uri>
    Example
    <THIS-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the current page.
    Format
    uri
  - nextstring<uri>
    Example
    <NEXT-PAGE-URI>
    Description
    URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.
    Format
    uri

Response Headers

X-RateLimit-Remaininginteger<int32>
Description
The number of requests that can still be made without triggering a failure response.
Format
int32
X-RateLimit-Limitinteger<int32>
Description
The average number of requests per minute allowed.
Format
int32
X-RateLimit-Burstinteger<int32>
Description
The maximum number of concurrent API requests allowed.
Format
int32

default

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).

Error
- httpStatusinteger<int32>
  Example
  400
  Description
  HTTP status code of the operation.
  Format
  int32
- messagesErrorMessage[]
  - errorCodestring
    Example
    123
    Description
    Application internal error code.
  - messagestring
    Example
    Error message example.
    Description
    A human-readable message.

curl

curl --request GET \
     --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer%3Cint32%3E&offset=integer%3Cint32%3E&limit=1000' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/loadbalancers?pretty=true&depth=integer<int32>&offset=integer<int32>&limit=1000"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": {},
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": {},
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "My resource",
        "ip": "22.231.113.64",
        "dhcp": true
      },
      "entities": {
        "balancednics": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": {},
          "href": "<RESOURCE-URI>",
          "items": [
            {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "metadata": {
                "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
                "createdDate": "2015-12-04T14:34:09.809Z",
                "createdBy": "[email protected]",
                "createdByUserId": "[email protected]",
                "lastModifiedDate": "2015-12-04T14:34:09.809Z",
                "lastModifiedBy": "[email protected]",
                "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
                "state": "AVAILABLE"
              },
              "properties": {
                "name": "My resource",
                "mac": "00:0a:95:9d:68:16",
                "ips": [
                  ""
                ],
                "dhcp": true,
                "ipv6Ips": [
                  ""
                ],
                "ipv6CidrBlock": "2001:db8:b06d:8f5a:0609::/80",
                "dhcpv6": true,
                "lan": 2,
                "firewallActive": false,
                "firewallType": "INGRESS",
                "deviceNumber": 3,
                "pciSlot": 7,
                "vnet": ""
              },
              "entities": {
                "flowlogs": {
                  "": ""
                },
                "firewallrules": {
                  "": ""
                },
                "securitygroups": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        }
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

default

// 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).
{
  "httpStatus": 400,
  "messages": [
    {
      "errorCode": "123",
      "message": "Error message example."
    }
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.