> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/api-reference/cloud-api-v6/data-centers/list-your-data-centers.md). # List your data centers List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items. ```json {"openapi":"3.0.3","info":{"title":"CLOUD API","version":"6.0"},"tags":[{"name":"Data centers"}],"servers":[{"url":"https://api.ionos.com/cloudapi/v6"}],"security":[{"BasicAuthentication":[]},{"TokenAuthentication":[]}],"components":{"securitySchemes":{"BasicAuthentication":{"type":"http","description":"You will need to base64 encode the string containing your credentials.
\n Note:

\n
Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication","scheme":"basic"},"TokenAuthentication":{"type":"apiKey","description":"Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.","name":"Authorization","in":"header"}},"schemas":{"Datacenters":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Datacenter"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Type":{"type":"string","enum":["datacenter","server","volume","nic","loadbalancer","location","firewall-rule","flow-log","image","snapshot","lan","ipblock","pcc","contract","user","group","collection","resource","request","request-status","s3key","backupunit","label","k8s","nodepool","template","networkloadbalancer","forwarding-rule","natgateway","natgateway-rule","node","applicationloadbalancer","target-group","security-group","gpu"]},"Datacenter":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/DatacenterProperties"},"entities":{"$ref":"#/components/schemas/DatacenterEntities"}}},"DatacenterElementMetadata":{"type":"object","properties":{"etag":{"type":"string","description":"Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.","readOnly":true},"createdDate":{"type":"string","description":"The last time the resource was created.","format":"date-time","readOnly":true},"createdBy":{"type":"string","description":"The user who created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","description":"The last time the resource was modified.","format":"date-time","readOnly":true},"lastModifiedBy":{"type":"string","description":"The user who last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"state":{"type":"string","description":"State of the resource. *AVAILABLE* There are no pending modification requests for this item; *BUSY* There is at least one modification request pending and all following requests will be queued; *INACTIVE* Resource has been de-provisioned; *DEPLOYING* Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; *ACTIVE* Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; *FAILED* Resource state FAILED - relevant for Kubernetes cluster/nodepool; *SUSPENDED* Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; *FAILED_SUSPENDED* Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; *UPDATING* Resource state UPDATING - relevant for Kubernetes cluster/nodepool; *FAILED_UPDATING* Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; *DESTROYING* Resource state DESTROYING - relevant for Kubernetes cluster; *FAILED_DESTROYING* Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; *TERMINATED* Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; *HIBERNATING* Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; *FAILED_HIBERNATING* Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; *MAINTENANCE* Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; *FAILED_HIBERNATING* Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.","readOnly":true,"enum":["AVAILABLE","INACTIVE","BUSY","DEPLOYING","ACTIVE","FAILED","SUSPENDED","FAILED_SUSPENDED","UPDATING","FAILED_UPDATING","DESTROYING","FAILED_DESTROYING","TERMINATED","HIBERNATING","FAILED_HIBERNATING","MAINTENANCE","FAILED_MAINTENANCE","UNKNOWN"]}}},"DatacenterProperties":{"required":["location"],"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"A description for the datacenter, such as staging, production."},"location":{"type":"string","description":"The physical location where the datacenter will be created. This will be where all of your servers live. Property cannot be modified after datacenter creation (disallowed in update requests)."},"version":{"type":"integer","description":"The version of the data center; incremented with every change.","format":"int32","readOnly":true},"features":{"type":"array","description":"List of features supported by the location where this data center is provisioned.","readOnly":true,"items":{"type":"string"}},"secAuthProtection":{"type":"boolean","description":"Boolean value representing if the data center requires extra protection, such as two-step verification."},"cpuArchitecture":{"type":"array","description":"Array of features and CPU families available in a location","readOnly":true,"items":{"$ref":"#/components/schemas/CpuArchitectureProperties"}},"gpuArchitecture":{"type":"array","description":"The types of GPU cards that are available in the location where the data center is provisioned.","readOnly":true,"items":{"$ref":"#/components/schemas/GpuArchitectureProperties"}},"ipv6CidrBlock":{"type":"string","description":"This value is either 'null' or contains an automatically-assigned /56 IPv6 CIDR block if IPv6 is enabled on this virtual data center. It can neither be changed nor removed.","nullable":true,"readOnly":true},"defaultSecurityGroupId":{"type":"string","description":"Optional property to define the default security group of the datacenter.","format":"uuid"}}},"CpuArchitectureProperties":{"type":"object","properties":{"cpuFamily":{"type":"string","description":"A valid CPU family name."},"maxCores":{"type":"integer","description":"The maximum number of cores available.","format":"int32"},"maxRam":{"type":"integer","description":"The maximum RAM size in MB.","format":"int32"},"vendor":{"type":"string","description":"A valid CPU vendor name."},"enabledFeatures":{"type":"array","description":"A list of enabled CPU features.","items":{"type":"string"}}}},"GpuArchitectureProperties":{"type":"object","properties":{"vendor":{"type":"string","description":"The vendor of the Graphics Processing Unit (GPU) card."},"model":{"type":"string","description":"The model of the Graphics Processing Unit (GPU) card."}}},"DatacenterEntities":{"type":"object","properties":{"servers":{"$ref":"#/components/schemas/Servers"},"volumes":{"$ref":"#/components/schemas/Volumes"},"loadbalancers":{"$ref":"#/components/schemas/Loadbalancers"},"lans":{"$ref":"#/components/schemas/Lans"},"networkloadbalancers":{"$ref":"#/components/schemas/NetworkLoadBalancers"},"natgateways":{"$ref":"#/components/schemas/NatGateways"},"securitygroups":{"$ref":"#/components/schemas/SecurityGroups"}}},"Servers":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Server"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Server":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/ServerProperties"},"entities":{"$ref":"#/components/schemas/ServerEntities"}}},"ServerProperties":{"type":"object","properties":{"templateUuid":{"type":"string","description":"The ID of the template for creating CUBE or GPU servers. If a template has GPU cards assigned, then it can only be used to create GPU servers, otherwise it can only be used for CUBE servers. The available templates can be found on the templates resource."},"name":{"type":"string","description":"The name of the resource."},"hostname":{"type":"string","description":"The hostname of the resource. Allowed characters are a-z, 0-9 and - (minus). Hostname should not start with minus and should not be longer than 63 characters."},"cores":{"type":"integer","description":"The total number of cores for the server. It can not be supplied for the VMs that have to be created based on templates. For servers with Confidential Computing enabled, the number of cores must match the amount of cores required by the Confidential Computing image, and this field is immutable once the server has been created — update requests attempting to change it will be rejected.","format":"int32"},"ram":{"type":"integer","description":"The memory size for the server in MB, such as 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set ramHotPlug to TRUE then you must use a minimum of 1024 MB. If you set the RAM size more than 240GB, then ramHotPlug will be set to FALSE and can not be set to TRUE unless RAM size not set to less than 240GB. It can not be supplied for the VMs that have to be created based on templates. For servers with Confidential Computing enabled, this field is immutable once the server has been created — update requests attempting to change it will be rejected.","format":"int32"},"availabilityZone":{"type":"string","description":"The availability zone in which the server should be provisioned. For CUBE and GPU servers, the only value accepted is 'AUTO'. For servers with Confidential Computing enabled, this field is immutable once the server has been created — update requests attempting to change it will be rejected.","enum":["AUTO","ZONE_1","ZONE_2"]},"vmState":{"type":"string","description":"Status of the virtual machine.","readOnly":true,"enum":["NOSTATE","RUNNING","BLOCKED","PAUSED","SHUTDOWN","SHUTOFF","CRASHED","SUSPENDED"]},"bootCdrom":{"description":"Reference to a CD-ROM used as boot device. Forbidden when the server has a volume whose image is a Confidential Computing image: such a server must boot from that volume and cannot boot from a CD-ROM. On servers with Confidential Computing enabled this field is immutable — update requests attempting to change it will be rejected.","allOf":[{"$ref":"#/components/schemas/ResourceReference"}]},"bootVolume":{"description":"Reference to a volume used as boot device. If the server has a volume with a Confidential Computing image, that volume — and only that volume — is eligible as the boot volume. Setting `bootVolume` to any other volume is rejected. If `bootVolume` is not provided on a server that has a Confidential Computing volume, that volume is automatically selected as the boot device. On servers with Confidential Computing enabled this field is immutable once the server has been created — update requests attempting to change it will be rejected.","allOf":[{"$ref":"#/components/schemas/ResourceReference"}]},"cpuFamily":{"type":"string","description":"CPU architecture on which server gets provisioned; not all CPU architectures are available in all datacenter regions; available CPU architectures can be retrieved from the datacenter resource; must not be provided for CUBE and VCPU servers. If the field is omitted from the request or the value is empty or null, an available CPU architecture will be automatically selected. This field must not be supplied when creating a server with Confidential Computing enabled (i.e. when one of the attached volumes uses a confidential computing image); in that case the CPU family is determined by the image and is selected automatically. On servers with Confidential Computing enabled this field is also immutable — update requests attempting to change it will be rejected."},"type":{"type":"string","description":"Server type: CUBE, ENTERPRISE, VCPU or GPU. Confidential Computing can be enabled only on a server of type ENTERPRISE by creating it with a volume with a Confidential Computing image."},"enabledFeatures":{"type":"array","description":"The list of features enabled on this server. An ENTERPRISE server with Confidential Computing enabled will have `SEV-SNP` as part of this list.","readOnly":true,"items":{"type":"string"}},"placementGroupId":{"type":"string","description":"The placement group ID that belongs to this server; Requires system privileges, for internal usage only"},"nicMultiQueue":{"type":"boolean","description":"Activate or deactivate the Multi Queue feature on all NICs of this server. This feature is beneficial to enable when the NICs are experiencing performance issues (e.g. low throughput). Toggling this feature will also initiate a restart of the server. If the specified value is `true`, the feature will be activated; if it is not specified or set to `false`, the feature will be deactivated. It is not allowed for servers of type Cube."},"maxNetworkBandwidth":{"type":"number","description":"The maximum bandwidth in Gbps as specified by NQoS tiers","readOnly":true,"format":"float"},"maintenanceWindow":{"description":"The scheduled maintenance window during which the virtual machine may be unavailable. This field is read-only and is only populated when a maintenance window has been scheduled and its end date has not yet passed; otherwise it is returned as `null`.","readOnly":true,"nullable":true,"allOf":[{"$ref":"#/components/schemas/ServerMaintenanceWindow"}]}}},"ResourceReference":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier."},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true}}},"ServerMaintenanceWindow":{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the maintenance window in ISO-8601 UTC format."},"endDate":{"type":"string","format":"date-time","description":"The end of the maintenance window in ISO-8601 UTC format. Always strictly after `startDate`."}}},"ServerEntities":{"type":"object","properties":{"cdroms":{"$ref":"#/components/schemas/Cdroms"},"volumes":{"$ref":"#/components/schemas/AttachedVolumes"},"nics":{"$ref":"#/components/schemas/Nics"},"securitygroups":{"$ref":"#/components/schemas/SecurityGroups"},"gpus":{"$ref":"#/components/schemas/GPUs"}}},"Cdroms":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/Image"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Image":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/ImageProperties"}}},"ImageProperties":{"required":["licenceType"],"type":"object","properties":{"name":{"type":"string","description":"The resource name."},"description":{"type":"string","description":"Human-readable description."},"location":{"type":"string","description":"The location of this image/snapshot.","readOnly":true},"size":{"type":"number","description":"The image size in GB.","readOnly":true},"cpuHotPlug":{"type":"boolean","description":"Hot-plug capable CPU (no reboot required)."},"cpuHotUnplug":{"type":"boolean","description":"Hot-unplug capable CPU (no reboot required)."},"ramHotPlug":{"type":"boolean","description":"Hot-plug capable RAM (no reboot required)."},"ramHotUnplug":{"type":"boolean","description":"Hot-unplug capable RAM (no reboot required)."},"nicHotPlug":{"type":"boolean","description":"Hot-plug capable NIC (no reboot required)."},"nicHotUnplug":{"type":"boolean","description":"Hot-unplug capable NIC (no reboot required)."},"discVirtioHotPlug":{"type":"boolean","description":"Hot-plug capable Virt-IO drive (no reboot required)."},"discVirtioHotUnplug":{"type":"boolean","description":"Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs."},"discScsiHotPlug":{"type":"boolean","description":"Hot-plug capable SCSI drive (no reboot required)."},"discScsiHotUnplug":{"type":"boolean","description":"Hot-unplug capable SCSI drive (no reboot required). Not supported with Windows VMs."},"exposeSerial":{"$ref":"#/components/schemas/ExposeSerial"},"requireLegacyBios":{"$ref":"#/components/schemas/RequireLegacyBios"},"licenceType":{"type":"string","description":"The OS type of this image."},"applicationType":{"$ref":"#/components/schemas/ApplicationType"},"imageType":{"type":"string","description":"The image type.","readOnly":true,"enum":["HDD","CDROM","UNKNOWN"]},"public":{"type":"boolean","description":"Indicates whether the image is part of a public repository.","readOnly":true},"imageAliases":{"type":"array","description":"List of image aliases mapped for this image","readOnly":true,"items":{"type":"string"}},"requiredFeatures":{"type":"array","description":"The list of features required by this image. If `SEV-SNP` is part of this list, then the image supports Confidential Computing.","readOnly":true,"items":{"type":"string"}},"cloudInit":{"type":"string","description":"Cloud init compatibility.","enum":["NONE","V1"]}}},"ExposeSerial":{"type":"boolean","description":"If set to `true` will expose the serial id of the disk attached to the server. If set to `false` will not expose the serial id. Some operating systems or software solutions require the serial id to be exposed to work properly. Exposing the serial can influence licensed software (e.g. Windows) behavior","default":false},"RequireLegacyBios":{"type":"boolean","description":"Indicates if the image requires the legacy BIOS for compatibility or specific needs.","default":true},"ApplicationType":{"type":"string","description":"The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN."},"PaginationOffsetOptional":{"type":"number","description":"The offset (if specified in the request)."},"PaginationLimitOptional":{"type":"number","description":"The limit (if specified in the request)."},"PaginationLinks":{"type":"object","properties":{"prev":{"type":"string","description":"URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.","format":"uri","readOnly":true},"self":{"type":"string","description":"URL (with offset and limit parameters) of the current page.","format":"uri","readOnly":true},"next":{"type":"string","description":"URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.","format":"uri","readOnly":true}}},"AttachedVolumes":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/Volume"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Volume":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/VolumeProperties"}}},"VolumeProperties":{"required":["size"],"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server. `ESSENTIAL`, `BALANCED`, and `PERFORMANCE` are the current performance classes (formerly `HDD`, `SSD Standard`, and `SSD Premium` respectively); the legacy names remain valid for existing volumes but are deprecated for new volumes.","enum":["HDD","SSD","SSD Standard","SSD Premium","DAS","ISO","ESSENTIAL","BALANCED","PERFORMANCE"]},"size":{"type":"number","description":"The size of the volume in GB."},"availabilityZone":{"type":"string","description":"The availability zone in which the volume should be provisioned. The storage volume will be provisioned on as few physical storage devices as possible, but this cannot be guaranteed upfront. This is uavailable for DAS (Direct Attached Storage), and subject to availability for SSD.","enum":["AUTO","ZONE_1","ZONE_2","ZONE_3"]},"image":{"type":"string","description":"Image or snapshot ID to be used as template for this volume. MSSQL Enterprise Images can be used only if the feature toggle for MSSQL Enterprise is enabled on the contract. If the referenced image supports Confidential Computing, additional rules apply: the volume can only be created inline as part of a server creation request (not via standalone volume creation, nor by attaching to an existing server), and exactly one volume on that server may use such an image. The resulting volume is permanently bound to the server as its boot device and cannot be detached or moved to another server."},"imagePassword":{"type":"string","description":"Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9."},"sshKeys":{"type":"array","description":"Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation.","items":{"type":"string"}},"bus":{"type":"string","description":"The bus type for this volume; default is VIRTIO.","enum":["VIRTIO","IDE","UNKNOWN"]},"licenceType":{"type":"string","description":"OS type for this volume."},"applicationType":{"$ref":"#/components/schemas/ApplicationType"},"cpuHotPlug":{"type":"boolean","description":"Hot-plug capable CPU (no reboot required)."},"ramHotPlug":{"type":"boolean","description":"Hot-plug capable RAM (no reboot required)."},"nicHotPlug":{"type":"boolean","description":"Hot-plug capable NIC (no reboot required)."},"nicHotUnplug":{"type":"boolean","description":"Hot-unplug capable NIC (no reboot required)."},"discVirtioHotPlug":{"type":"boolean","description":"Hot-plug capable Virt-IO drive (no reboot required)."},"discVirtioHotUnplug":{"type":"boolean","description":"Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs."},"exposeSerial":{"$ref":"#/components/schemas/ExposeSerial"},"requireLegacyBios":{"$ref":"#/components/schemas/RequireLegacyBios"},"deviceNumber":{"type":"integer","description":"The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.","format":"int64","readOnly":true},"pciSlot":{"type":"integer","description":"The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.","format":"int32","readOnly":true},"backupunitId":{"type":"string","format":"uuid","description":"The ID of the backup unit that the user has access to. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property."},"userData":{"type":"string","description":"The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property. This field is blocked for Confidential Computing VM storage."},"bootServer":{"type":"string","description":"The UUID of the attached server.","readOnly":true},"bootOrder":{"type":"string","description":"Determines whether the volume will be used as a boot volume. Set to `NONE`, the volume will not be used as boot volume. Set to `PRIMARY`, the volume will be used as boot volume and all other volumes must be set to `NONE`. Set to `AUTO` or `null` requires all volumes to be set to `AUTO` or `null`; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices.\nA volume with a Confidential Computing image may be created with `bootOrder` set to `PRIMARY` (or left unset / `AUTO`, in which case it is automatically treated as the boot device), but it must not be created with `bootOrder` set to `NONE`. Conversely, no other volume attached to the same server is allowed to be set to `PRIMARY` — only the confidential computing volume can be the boot device.","nullable":true,"default":"AUTO","enum":["AUTO","NONE","PRIMARY"]}}},"Nics":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/Nic"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Nic":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NicProperties"},"entities":{"$ref":"#/components/schemas/NicEntities"}}},"NicProperties":{"required":["lan"],"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"mac":{"type":"string","description":"The MAC address of the NIC. On NIC creation you can specify a custom MAC address. If you do not provide one, a MAC address will be automatically assigned. Ensure that any custom MAC address is unicast, adhering to the format xy:xx:xx:xx:xx:xx. Here, x represents any hexadecimal digit (0-9, a-f, A-F), and y must be precisely one of 0, 2, 4, 6, 8, A, C, E (or equivalently a, c, e) to conform with unicast addressing requirements. Two NICs from the same server may not have the same MAC address. Two NICs on the same LAN can but should not have the same MAC address."},"ips":{"type":"array","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.","nullable":true,"items":{"type":"string"}},"dhcp":{"type":"boolean","description":"Indicates if the NIC will reserve an IP using DHCP.","default":true},"ipv6Ips":{"type":"array","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.","nullable":true,"items":{"type":"string"}},"ipv6CidrBlock":{"type":"string","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.","nullable":true},"dhcpv6":{"type":"boolean","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.","nullable":true,"default":true},"lan":{"type":"integer","description":"The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.","format":"int32"},"firewallActive":{"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."},"firewallType":{"type":"string","description":"The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.","enum":["INGRESS","EGRESS","BIDIRECTIONAL"]},"deviceNumber":{"type":"integer","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","readOnly":true},"pciSlot":{"type":"integer","description":"The PCI slot number for the NIC.","format":"int32","readOnly":true},"vnet":{"type":"string","description":"The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only"}}},"NicEntities":{"type":"object","properties":{"flowlogs":{"$ref":"#/components/schemas/FlowLogs"},"firewallrules":{"$ref":"#/components/schemas/FirewallRules"},"securitygroups":{"$ref":"#/components/schemas/SecurityGroups"}}},"FlowLogs":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/FlowLog"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowLog":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/FlowLogProperties"}}},"FlowLogProperties":{"required":["action","bucket","direction","name"],"type":"object","properties":{"name":{"type":"string","description":"The resource name."},"action":{"type":"string","description":"Specifies the traffic action pattern.","enum":["ACCEPTED","REJECTED","ALL"]},"direction":{"type":"string","description":"Specifies the traffic direction pattern.","enum":["INGRESS","EGRESS","BIDIRECTIONAL"]},"bucket":{"type":"string","description":"The bucket name of an existing IONOS CLOUD Object storage bucket."}}},"FirewallRules":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/FirewallRule"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FirewallRule":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/FirewallruleProperties"}}},"FirewallruleProperties":{"required":["protocol"],"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"protocol":{"type":"string","description":"The protocol for the rule. Property cannot be modified after it is created (disallowed in update requests).","enum":["TCP","UDP","ICMP","ICMPv6","GRE","VRRP","ESP","AH","ANY"]},"sourceMac":{"type":"string","description":"Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. Value null allows traffic from any MAC address.","nullable":true},"ipVersion":{"type":"string","description":"The IP version for this rule. If sourceIp or targetIp are specified, you can omit this value - the IP version will then be deduced from the IP address(es) used; if you specify it anyway, it must match the specified IP address(es). If neither sourceIp nor targetIp are specified, this rule allows traffic only for the specified IP version. If neither sourceIp, targetIp nor ipVersion are specified, this rule will only allow IPv4 traffic.","nullable":true,"enum":["IPv4","IPv6"]},"sourceIp":{"type":"string","description":"Only traffic originating from the respective IP address (or CIDR block) is allowed. Value null allows traffic from any IP address (according to the selected ipVersion).","nullable":true},"targetIp":{"type":"string","description":"If the target NIC has multiple IP addresses, only the traffic directed to the respective IP address (or CIDR block) of the NIC is allowed. Value null allows traffic to any target IP address (according to the selected ipVersion).","nullable":true},"icmpCode":{"maximum":254,"minimum":0,"type":"integer","description":"Defines the allowed code (from 0 to 254) if protocol ICMP or ICMPv6 is chosen. Value null allows all codes.","format":"int32","nullable":true},"icmpType":{"maximum":254,"minimum":0,"type":"integer","description":"Defines the allowed type (from 0 to 254) if the protocol ICMP or ICMPv6 is chosen. Value null allows all types.","format":"int32","nullable":true},"portRangeStart":{"maximum":65535,"minimum":1,"type":"integer","description":"Defines the start range of the allowed port (from 1 to 65535) if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports.","format":"int32"},"portRangeEnd":{"maximum":65535,"minimum":1,"type":"integer","description":"Defines the end range of the allowed port (from 1 to 65535) if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd null to allow all ports.","format":"int32"},"type":{"type":"string","description":"The type of the firewall rule. If not specified, the default INGRESS value is used.","enum":["INGRESS","EGRESS"]}}},"SecurityGroups":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/SecurityGroup"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"SecurityGroup":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/SecurityGroupProperties"},"entities":{"$ref":"#/components/schemas/SecurityGroupEntities"}}},"SecurityGroupProperties":{"required":["name"],"type":"object","properties":{"name":{"type":"string","maxLength":60,"description":"The name of the security group."},"description":{"type":"string","maxLength":300,"description":"The description of the security group."}}},"SecurityGroupEntities":{"type":"object","properties":{"rules":{"$ref":"#/components/schemas/FirewallRules"},"nics":{"$ref":"#/components/schemas/Nics"},"servers":{"$ref":"#/components/schemas/Servers"}}},"GPUs":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/GPU"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"GPU":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"The URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/GPUProperties"}}},"GPUProperties":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"The name of the resource.","readOnly":true},"vendor":{"type":"string","description":"The vendor of the Graphics Processing Unit (GPU) card. The available options can be retrieved from the 'gpuArchitecture' field returned in the GET responses of the resources /datacenters and /locations.","readOnly":true},"model":{"type":"string","description":"The model of Graphics Processing Unit (GPU) card. The available options can be retrieved from the 'gpuArchitecture' field returned in the GET responses of the resources /datacenters and /locations.","readOnly":true},"type":{"type":"string","description":"The way the Graphics Processing Unit (GPU) card will function. The 'passthrough' type means that the Server will be connected to the GPU directly (e.g. no virtualization involved).","readOnly":true}}},"Volumes":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Volume"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Loadbalancers":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Loadbalancer"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Loadbalancer":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/LoadbalancerProperties"},"entities":{"$ref":"#/components/schemas/LoadbalancerEntities"}}},"LoadbalancerProperties":{"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"ip":{"type":"string","description":"IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically.","nullable":true},"dhcp":{"type":"boolean","description":"Indicates if the loadbalancer will reserve an IP using DHCP."}}},"LoadbalancerEntities":{"type":"object","properties":{"balancednics":{"$ref":"#/components/schemas/BalancedNics"}}},"BalancedNics":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Nic"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Lans":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Lan"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Lan":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/LanProperties"},"entities":{"$ref":"#/components/schemas/LanEntities"}}},"LanProperties":{"type":"object","properties":{"name":{"type":"string","description":"The name of the resource."},"ipFailover":{"type":"array","description":"IP failover configurations for lan","items":{"$ref":"#/components/schemas/IPFailover"}},"ipv4CidrBlock":{"type":"string","description":"For public LANs this property is null, for private LANs it contains the private IPv4 CIDR range. This property is a read only property.","readOnly":true,"nullable":true},"ipv6CidrBlock":{"type":"string","description":"For a GET request, this value is either 'null' or contains the LAN's /64 IPv6 CIDR block if this LAN is IPv6 enabled. For POST/PUT/PATCH requests, 'AUTO' will result in enabling this LAN for IPv6 and automatically assign a /64 IPv6 CIDR block to this LAN and /80 IPv6 CIDR blocks to the NICs and one /128 IPv6 address to each connected NIC. If you choose the IPv6 CIDR block for the LAN on your own, then you must provide a /64 block, which is inside the IPv6 CIDR block of the virtual datacenter and unique inside all LANs from this virtual datacenter. If you enable IPv6 on a LAN with NICs, those NICs will get a /80 IPv6 CIDR block and one IPv6 address assigned to each automatically, unless you specify them explicitly on the LAN and on the NICs. A virtual data center is limited to a maximum of 256 IPv6-enabled LANs.","nullable":true},"pcc":{"type":"string","description":"The unique identifier of the Cross Connect the LAN is connected to, if any. It needs to be ensured that IP addresses of the NICs of all LANs connected to a given Cross Connect is not duplicated and belongs to the same subnet range."},"public":{"type":"boolean","description":"Indicates if the LAN is connected to the internet or not."},"vni":{"type":"integer","format":"int32","readOnly":true,"description":"The VNI value that is assigned to the LAN."}}},"IPFailover":{"type":"object","properties":{"ip":{"type":"string"},"nicUuid":{"type":"string"}}},"LanEntities":{"type":"object","properties":{"nics":{"$ref":"#/components/schemas/LanNics"}}},"LanNics":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/Nic"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"NetworkLoadBalancers":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/NetworkLoadBalancer"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"NetworkLoadBalancer":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NetworkLoadBalancerProperties"},"entities":{"$ref":"#/components/schemas/NetworkLoadBalancerEntities"}}},"NetworkLoadBalancerProperties":{"required":["listenerLan","name","targetLan"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Network Load Balancer."},"listenerLan":{"type":"integer","description":"ID of the listening LAN (inbound)."},"ips":{"type":"array","description":"Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers.","items":{"type":"string"}},"targetLan":{"type":"integer","description":"ID of the balanced private target LAN (outbound)."},"lbPrivateIps":{"type":"array","description":"Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.","items":{"type":"string"}},"centralLogging":{"type":"boolean","description":"Turn logging on and off for this product. Default value is 'false'."},"loggingFormat":{"type":"string","description":"Specifies the format of the logs."},"tier":{"type":"string","description":"The service tier the Network Load Balancer runs on. See `VnfServiceTier`.","allOf":[{"$ref":"#/components/schemas/VnfServiceTier"}]},"maintenanceWindow":{"nullable":true,"description":"The weekly slot in which IONOS may carry out disruptive work on this Network Load Balancer. Sending `null` clears a configured window, after which the resource follows the assignment rule again. See `VnfMaintenanceWindow`.","allOf":[{"$ref":"#/components/schemas/VnfMaintenanceWindow"}]}}},"VnfServiceTier":{"type":"string","description":"The service tiers a VNF resource can run on. Each names a performance class and a redundancy; the `_HA` suffix marks the redundant form, and both dimensions are compared by the upgrade-only rule below. What a tier resolves to in cores, memory and machine type is defined per product and is the same in every location.\n\n**Which tiers are accepted.** A tier the product's catalogue holds no entry for is refused, since nothing then defines what it resolves to. `STANDARD_HA` is the exception and is accepted whether or not the catalogue holds an entry for it; where it holds none, the resource is sized by the platform's own configuration for that product rather than by a catalogue entry.\n\n**Upgrades only.** A change that lowers either the performance class or the redundancy of the tier the resource is running is rejected.\n\n**Selecting a tier.** Naming a tier that differs from the one the resource is running, or on creation naming one other than the tier it would receive anyway, is a selection. A selection requires service tiers to be enabled on both the contract and the cluster, and is refused if either is not. Naming the tier a resource is already running is not a selection and is always accepted, so a resource that has been read can be written back without the feature enabled. Creating a resource on the tier it would receive anyway is likewise not a selection, so a client may equally create one from a resource it has read.\n\n**When a selection takes effect.** At once. Nothing is queued and nothing waits for the resource's maintenance window, so a resource's `tier` reports the tier it is running and never one it is moving to.\n\n**Omitting the tier.** On creation a resource starts on the tier configured as the default for its product, where service tiers are enabled on both the contract and the cluster; otherwise, and where the catalogue marks no default, it starts on `STANDARD_HA`. On update the resource keeps the tier it is running — an omitted tier is never read as a request to return to the default.\n\n**An open set.** The set of tiers may grow, so a client generated against this spec must tolerate a tier it does not recognise rather than fail on it. A tier this API does not yet define is still refused on write: an open set describes what a client may one day be told, not what it may send."},"VnfMaintenanceWindow":{"required":["dayOfTheWeek","time"],"type":"object","description":"The weekly slot in which IONOS may carry out disruptive work on a VNF resource. Set the window that suits you: it is recorded so that IONOS operations know when they may intervene on the resource, and the platform itself never acts on the stored value — no change to the resource is held back waiting for the window to open, and none is applied because it opened. Changing the window does not itself reprovision the resource.\n\n**A window is a span, not an instant.** It opens at the stated time and stays open for a fixed length, configured by the platform and the same for every resource; work may begin at any point while it is open.\n\n**Every resource has one at all times.** When none is configured, the system assigns one derived from the resource's identifier, which spreads assigned windows across the week instead of gathering every resource into one slot.\n\n**Setting and clearing.** Omitting the window when updating an existing resource leaves the window it already has unchanged. Sending it as `null` clears it, after which the resource follows the assignment rule again. Clearing is the way back for a resource that carries a window nobody chose for it — a copied data centre gives each copy the window of the resource it was copied from, because the copy states the window it was shown. The schemas that carry this window serve requests and responses alike, so the contract admits `null` in both; what the platform returns is always a window, configured or assigned.","properties":{"dayOfTheWeek":{"type":"string","description":"The weekday for a maintenance window.","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]},"time":{"type":"string","pattern":"^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-](0[0-9]|1[0-4])[0-5][0-9])?$","description":"The time of day the maintenance window opens, as a UTC wall-clock time. Accepted formats are `HH:mm:ss`, `HH:mm:ssZ`, and `HH:mm:ss±hhmm` with the offset written without a colon — an offset in the `±hh:mm` form is rejected. An offset that is given is accepted but **not applied**: the time is taken as stated and evaluated in UTC, so `13:00:00+0200` opens the window at 13:00 UTC and not at 11:00 UTC. Send the value already converted to UTC. Responses always report the bare `HH:mm:ss` form."}}},"NetworkLoadBalancerEntities":{"type":"object","properties":{"flowlogs":{"$ref":"#/components/schemas/FlowLogs"},"forwardingrules":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRules"}}},"NetworkLoadBalancerForwardingRules":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRule"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"NetworkLoadBalancerForwardingRule":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleProperties"}}},"NetworkLoadBalancerForwardingRuleProperties":{"required":["algorithm","listenerIp","listenerPort","name","protocol","targets"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Network Load Balancer forwarding rule."},"algorithm":{"type":"string","description":"Balancing algorithm","enum":["ROUND_ROBIN","LEAST_CONNECTION","RANDOM","SOURCE_IP"]},"protocol":{"type":"string","description":"Balancing protocol","enum":["HTTP","TCP"]},"listenerIp":{"type":"string","description":"Listening (inbound) IP."},"listenerPort":{"type":"integer","description":"Listening (inbound) port number; valid range is 1 to 65535.","format":"int32"},"healthCheck":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleHealthCheck"},"targets":{"type":"array","description":"Array of items in the collection.","items":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleTarget"}}}},"NetworkLoadBalancerForwardingRuleHealthCheck":{"type":"object","properties":{"clientTimeout":{"type":"integer","description":"The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).","format":"int32"},"connectTimeout":{"type":"integer","description":"The maximum time in milliseconds to wait for a connection attempt to a target to succeed; default is 5000 (five seconds).","format":"int32"},"targetTimeout":{"type":"integer","description":"The maximum time in milliseconds that a target can remain inactive; default is 50,000 (50 seconds).","format":"int32"},"retries":{"type":"integer","description":"The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535 and default is three reconnection attempts.","format":"int32"}}},"NetworkLoadBalancerForwardingRuleTarget":{"required":["ip","port","weight"],"type":"object","properties":{"ip":{"type":"string","description":"The IP of the balanced target VM."},"port":{"type":"integer","description":"The port of the balanced target service; valid range is 1 to 65535.","format":"int32"},"weight":{"type":"integer","description":"Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1. Targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best to assign weights in the middle of the range to leave room for later adjustments.","format":"int32"},"proxyProtocol":{"type":"string","description":"Proxy protocol version.","default":"none","enum":["none","v1","v2","v2ssl"]},"healthCheck":{"$ref":"#/components/schemas/NetworkLoadBalancerForwardingRuleTargetHealthCheck"}}},"NetworkLoadBalancerForwardingRuleTargetHealthCheck":{"type":"object","properties":{"check":{"type":"boolean","description":"Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target."},"checkInterval":{"type":"integer","description":"The interval in milliseconds between consecutive health checks; default is 2000.","format":"int32"},"maintenance":{"type":"boolean","description":"Maintenance mode prevents the target from receiving balanced traffic."}}},"NatGateways":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/NatGateway"}},"offset":{"$ref":"#/components/schemas/PaginationOffsetOptional"},"limit":{"$ref":"#/components/schemas/PaginationLimitOptional"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"NatGateway":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NatGatewayProperties"},"entities":{"$ref":"#/components/schemas/NatGatewayEntities"}}},"NatGatewayProperties":{"required":["name","publicIps"],"type":"object","properties":{"name":{"type":"string","description":"Name of the NAT Gateway."},"publicIps":{"type":"array","description":"Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location.","items":{"type":"string"}},"lans":{"type":"array","description":"Collection of LANs connected to the NAT Gateway. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.","items":{"$ref":"#/components/schemas/NatGatewayLanProperties"}},"tier":{"type":"string","description":"The service tier the NAT Gateway runs on. See `VnfServiceTier`.","allOf":[{"$ref":"#/components/schemas/VnfServiceTier"}]},"maintenanceWindow":{"nullable":true,"description":"The weekly slot in which IONOS may carry out disruptive work on this NAT Gateway. Sending `null` clears a configured window, after which the resource follows the assignment rule again. See `VnfMaintenanceWindow`.","allOf":[{"$ref":"#/components/schemas/VnfMaintenanceWindow"}]}}},"NatGatewayLanProperties":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Id for the LAN connected to the NAT Gateway","format":"int32"},"gatewayIps":{"type":"array","description":"Collection of gateway IP addresses of the NAT Gateway. Will be auto-generated if not provided. Should ideally be an IP belonging to the same subnet as the LAN","items":{"type":"string"}}}},"NatGatewayEntities":{"type":"object","properties":{"rules":{"$ref":"#/components/schemas/NatGatewayRules"},"flowlogs":{"$ref":"#/components/schemas/FlowLogs"}}},"NatGatewayRules":{"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"items":{"type":"array","description":"Array of items in the collection.","readOnly":true,"items":{"$ref":"#/components/schemas/NatGatewayRule"}}}},"NatGatewayRule":{"required":["properties"],"type":"object","properties":{"id":{"type":"string","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","description":"The type of object that has been created.","allOf":[{"$ref":"#/components/schemas/Type"}]},"href":{"type":"string","description":"URL to the object representation (absolute path).","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/DatacenterElementMetadata"},"properties":{"$ref":"#/components/schemas/NatGatewayRuleProperties"}}},"NatGatewayRuleProperties":{"required":["name","publicIp","sourceSubnet"],"type":"object","properties":{"name":{"type":"string","description":"The name of the NAT Gateway rule."},"type":{"type":"string","description":"Type of the NAT Gateway rule.","allOf":[{"$ref":"#/components/schemas/NatGatewayRuleType"}]},"protocol":{"type":"string","description":"Protocol of the NAT Gateway rule. Defaults to ALL. If protocol is 'ICMP' then targetPortRange start and end cannot be set.","allOf":[{"$ref":"#/components/schemas/NatGatewayRuleProtocol"}]},"sourceSubnet":{"type":"string","description":"Source subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets source IP address."},"publicIp":{"type":"string","description":"Public IP address of the NAT Gateway rule. Specifies the address used for masking outgoing packets source address field. Should be one of the customer reserved IP address already configured on the NAT Gateway resource"},"targetSubnet":{"type":"string","description":"Target or destination subnet of the NAT Gateway rule. For SNAT rules it specifies which packets this translation rule applies to based on the packets destination IP address. If none is provided, rule will match any address."},"targetPortRange":{"$ref":"#/components/schemas/TargetPortRange"}}},"NatGatewayRuleType":{"type":"string","enum":["SNAT"]},"NatGatewayRuleProtocol":{"type":"string","enum":["TCP","UDP","ICMP","ALL"]},"TargetPortRange":{"type":"object","properties":{"start":{"type":"integer","description":"Target port range start associated with the NAT Gateway rule.","format":"int32"},"end":{"type":"integer","description":"Target port range end associated with the NAT Gateway rule.","format":"int32"}}},"Error":{"type":"object","properties":{"httpStatus":{"type":"integer","description":"HTTP status code of the operation.","format":"int32","readOnly":true},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string","description":"Application internal error code.","readOnly":true},"message":{"type":"string","description":"A human-readable message.","readOnly":true}}}}},"paths":{"/datacenters":{"get":{"tags":["Data centers"],"summary":"List your data centers","description":"List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.","operationId":"datacentersGet","parameters":[{"name":"pretty","in":"query","description":"Controls whether the response is pretty-printed (with indentations and new lines).","schema":{"type":"boolean","default":true}},{"name":"depth","in":"query","description":"Controls the detail depth of the response objects. \nGET /datacenters/[ID]\n\t- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n\t- depth=1: Direct properties and children references are included.\n\t- depth=2: Direct properties and children properties are included.\n\t- depth=3: Direct properties and children properties and children's children are included.\n\t- depth=... and so on","schema":{"maximum":10,"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"X-Contract-Number","in":"header","description":"Users with multiple contracts must provide the contract number, for which all API requests are to be executed.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of elements to return (use together with offset for pagination).","schema":{"maximum":10000,"minimum":1,"type":"integer","format":"int32","default":1000}}],"responses":{"200":{"description":"Successful operation","headers":{"X-RateLimit-Remaining":{"description":"The number of requests that can still be made without triggering a failure response.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Limit":{"description":"The average number of requests per minute allowed.","schema":{"type":"integer","format":"int32"}},"X-RateLimit-Burst":{"description":"The maximum number of concurrent API requests allowed.","schema":{"type":"integer","format":"int32"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datacenters"}}}},"default":{"description":"Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/api-reference/cloud-api-v6/data-centers/list-your-data-centers.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.