List your data centers

1 min

GET

https://api.ionos.com/cloudapi/v6/datacenters

List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.

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

Datacenters
- 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
- itemsDatacenter[]
  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
  - propertiesDatacenterPropertiesrequired
    - namestring
      Example
      Production datacenter
      Description
      The name of the resource.
    - descriptionstring
      Example
      My Production Datacenter
      Description
      A description for the datacenter, such as staging, production.
    - locationstringrequired
      Example
      us/las
      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).
    - versioninteger<int32>
      Example
      8
      Description
      The version of the data center; incremented with every change.
      Format
      int32
    - featuresstring[]
      Example
      [ "SSD" ]
      Description
      List of features supported by the location where this data center is provisioned.
    - secAuthProtectionboolean
      Example
      true
      Description
      Boolean value representing if the data center requires extra protection, such as two-step verification.
    - cpuArchitectureCpuArchitectureProperties[]
      Description
      Array of features and CPU families available in a location
      - cpuFamilystring
        Example
        INTEL_ICELAKE
        Description
        A valid CPU family name.
      - maxCoresinteger<int32>
        Example
        62
        Description
        The maximum number of cores available.
        Format
        int32
      - maxRaminteger<int32>
        Example
        245760
        Description
        The maximum RAM size in MB.
        Format
        int32
      - vendorstring
        Example
        AuthenticAMD
        Description
        A valid CPU vendor name.
      - enabledFeaturesstring[]
        Example
        [ "SEV-SNP" ]
        Description
        A list of enabled CPU features.
    - gpuArchitectureGpuArchitectureProperties[]
      Description
      The types of GPU cards that are available in the location where the data center is provisioned.
      - vendorstring
        Example
        NVIDIA
        Description
        The vendor of the Graphics Processing Unit (GPU) card.
      - modelstring
        Example
        A100
        Description
        The model of the Graphics Processing Unit (GPU) card.
    - ipv6CidrBlockstring
      Example
      2001:db8:b06d:8f00::/56
      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.
    - defaultSecurityGroupIdstring<uuid>
      Example
      15f67991-0f51-4efc-a8ad-ef1fb31a480c
      Description
      Optional property to define the default security group of the datacenter.
      Format
      uuid
  - entitiesDatacenterEntities
    - serversServers
      - 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
      - itemsServer[]
        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
        propertiesServerPropertiesrequired
        templateUuidstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        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.
        namestring
        Example
        My resource
        Description
        The name of the resource.
        hostnamestring
        Example
        myHostname
        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.
        coresinteger<int32>
        Example
        4
        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
        raminteger<int32>
        Example
        4096
        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
        availabilityZonestring<AUTO | ZONE_1 | ZONE_2>
        Example
        AUTO
        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.
        Allowed
        AUTOZONE_1ZONE_2
        vmStatestring<NOSTATE | RUNNING | BLOCKED | PAUSED | SHUTDOWN | SHUTOFF | CRASHED | SUSPENDED>
        Example
        RUNNING
        Description
        Status of the virtual machine.
        Allowed
        NOSTATERUNNINGBLOCKEDPAUSEDSHUTDOWNSHUTOFFCRASHEDSUSPENDED
        bootCdromobject
        ResourceReference
        Max depth limit reached
        bootVolumeobject
        ResourceReference
        Max depth limit reached
        cpuFamilystring
        Example
        INTEL_ICELAKE
        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.
        typestring
        Example
        CUBE
        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.
        enabledFeaturesstring[]
        Example
        [ "SEV-SNP" ]
        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.
        placementGroupIdstring
        Description
        The placement group ID that belongs to this server; Requires system privileges, for internal usage only
        nicMultiQueueboolean
        Example
        true
        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.
        maxNetworkBandwidthnumber<float>
        Example
        6
        Description
        The maximum bandwidth in Gbps as specified by NQoS tiers
        Format
        float
        entitiesServerEntities
        cdromsCdroms
        Max depth limit reached
        volumesAttachedVolumes
        Max depth limit reached
        nicsNics
        Max depth limit reached
        securitygroupsSecurityGroups
        Max depth limit reached
        gpusGPUs
        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
    - volumesVolumes
      - 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
      - itemsVolume[]
        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
        The 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
        propertiesVolumePropertiesrequired
        namestring
        Example
        My resource
        Description
        The name of the resource.
        typestring<HDD | SSD | SSD Standard | SSD Premium | DAS | ISO>
        Example
        HDD
        Description
        Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.
        Allowed
        HDDSSDSSD StandardSSD PremiumDASISO
        sizenumberrequired
        Example
        100
        Description
        The size of the volume in GB.
        availabilityZonestring<AUTO | ZONE_1 | ZONE_2 | ZONE_3>
        Example
        AUTO
        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.
        Allowed
        AUTOZONE_1ZONE_2ZONE_3
        imagestring
        Example
        d6ad1576-fde9-4696-aa41-1ebd75bdaf49
        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.
        imagePasswordstring
        Example
        mypass123
        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.
        sshKeysstring[]
        Example
        [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/4JNoFQBsaGV974hDmloS5LOvSJjKpXs8Ed437ln712345", "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/asdfghjkjhyutry545tgvbn76e4rf43" ]
        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.
        busstring<VIRTIO | IDE | UNKNOWN>
        Example
        VIRTIO
        Description
        The bus type for this volume; default is VIRTIO.
        Allowed
        VIRTIOIDEUNKNOWN
        licenceTypestring
        Example
        LINUX
        Description
        OS type for this volume.
        applicationTypeApplicationType
        Example
        MSSQL-2019-Standard
        Description
        The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN.
        Max depth limit reached
        cpuHotPlugboolean
        Example
        true
        Description
        Hot-plug capable CPU (no reboot required).
        ramHotPlugboolean
        Example
        true
        Description
        Hot-plug capable RAM (no reboot required).
        nicHotPlugboolean
        Example
        true
        Description
        Hot-plug capable NIC (no reboot required).
        nicHotUnplugboolean
        Example
        true
        Description
        Hot-unplug capable NIC (no reboot required).
        discVirtioHotPlugboolean
        Example
        true
        Description
        Hot-plug capable Virt-IO drive (no reboot required).
        discVirtioHotUnplugboolean
        Example
        true
        Description
        Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.
        exposeSerialExposeSerial
        Example
        true
        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
        Max depth limit reached
        requireLegacyBiosRequireLegacyBios
        Example
        true
        Description
        Indicates if the image requires the legacy BIOS for compatibility or specific needs.
        Default
        true
        Max depth limit reached
        deviceNumberinteger<int64>
        Example
        3
        Description
        The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.
        Format
        int64
        pciSlotinteger<int32>
        Example
        7
        Description
        The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.
        Format
        int32
        backupunitIdstring<uuid>
        Example
        25f67991-0f51-4efc-a8ad-ef1fb31a481c
        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.
        Format
        uuid
        userDatastring
        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.
        bootServerstring
        Example
        25f67991-0f51-4efc-a8ad-ef1fb31a481c
        Description
        The UUID of the attached server.
        bootOrderstring<AUTO | NONE | PRIMARY>
        Example
        AUTO
        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. A 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.
        Default
        AUTO
        Allowed
        AUTONONEPRIMARY
      - 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
    - loadbalancersLoadbalancers
      - 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
        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
    - lansLans
      - 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
      - itemsLan[]
        Description
        Array of items in the collection.
        idstring
        Example
        5
        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
        propertiesLanPropertiesrequired
        namestring
        Example
        My resource
        Description
        The name of the resource.
        ipFailoverIPFailover[]
        Description
        IP failover configurations for lan
        Max depth limit reached
        ipv4CidrBlockstring
        Example
        10.8.130.0/23
        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.
        ipv6CidrBlockstring
        Example
        2001:db8:b06d:8f5a::/64
        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.
        pccstring
        Example
        3c11273c-b3e1-4ca3-8134-84fd2dd4ebec
        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.
        publicboolean
        Example
        true
        Description
        Indicates if the LAN is connected to the internet or not.
        vniinteger<int32>
        Example
        123
        Description
        The VNI value that is assigned to the LAN.
        Format
        int32
        entitiesLanEntities
        nicsLanNics
        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
    - networkloadbalancersNetworkLoadBalancers
      - 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
      - itemsNetworkLoadBalancer[]
        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
        propertiesNetworkLoadBalancerPropertiesrequired
        namestringrequired
        Example
        My Network Load Balancer
        Description
        The name of the Network Load Balancer.
        listenerLanintegerrequired
        Example
        1
        Description
        ID of the listening LAN (inbound).
        ipsstring[]
        Example
        [ "81.173.1.2", "22.231.2.2", "22.231.2.3" ]
        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.
        targetLanintegerrequired
        Example
        2
        Description
        ID of the balanced private target LAN (outbound).
        lbPrivateIpsstring[]
        Example
        [ "81.173.1.5/24", "22.231.2.5/24" ]
        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.
        centralLoggingboolean
        Example
        true
        Description
        Turn logging on and off for this product. Default value is 'false'.
        loggingFormatstring
        Example
        %{+Q}o %{-Q}ci - - [%trg] %r %ST %B "" "" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl
        Description
        Specifies the format of the logs.
        entitiesNetworkLoadBalancerEntities
        flowlogsFlowLogs
        Max depth limit reached
        forwardingrulesNetworkLoadBalancerForwardingRules
        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
    - natgatewaysNatGateways
      - 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
      - itemsNatGateway[]
        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
        propertiesNatGatewayPropertiesrequired
        namestringrequired
        Example
        My NAT Gateway
        Description
        Name of the NAT Gateway.
        publicIpsstring[]required
        Example
        [ "81.173.1.2", "82.231.2.5", "92.221.2.4" ]
        Description
        Collection of public IP addresses of the NAT Gateway. Should be customer reserved IP addresses in that location.
        lansNatGatewayLanProperties[]
        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.
        Max depth limit reached
        entitiesNatGatewayEntities
        rulesNatGatewayRules
        Max depth limit reached
        flowlogsFlowLogs
        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
    - securitygroupsSecurityGroups
      - idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
      - typeobject
        Type
      - hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        The URL to the object representation (absolute path).
        Format
        uri
      - itemsSecurityGroup[]
        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
        The 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
        propertiesSecurityGroupPropertiesrequired
        namestringrequired
        Example
        My security group
        Description
        The name of the security group.
        Max Length
        60
        descriptionstring
        Example
        My security group description
        Description
        The description of the security group.
        Max Length
        300
        entitiesSecurityGroupEntities
        rulesFirewallRules
        Max depth limit reached
        nicsNics
        Max depth limit reached
        serversServers
        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?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?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?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?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": "Production datacenter",
        "description": "My Production Datacenter",
        "location": "us/las",
        "version": 8,
        "features": [
          ""
        ],
        "secAuthProtection": true,
        "cpuArchitecture": [
          {
            "cpuFamily": "INTEL_ICELAKE",
            "maxCores": 62,
            "maxRam": 245760,
            "vendor": "AuthenticAMD",
            "enabledFeatures": [
              ""
            ]
          }
        ],
        "gpuArchitecture": [
          {
            "vendor": "NVIDIA",
            "model": "A100"
          }
        ],
        "ipv6CidrBlock": "2001:db8:b06d:8f00::/56",
        "defaultSecurityGroupId": "15f67991-0f51-4efc-a8ad-ef1fb31a480c"
      },
      "entities": {
        "servers": {
          "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": {
                "templateUuid": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
                "name": "My resource",
                "hostname": "myHostname",
                "cores": 4,
                "ram": 4096,
                "availabilityZone": "AUTO",
                "vmState": "RUNNING",
                "bootCdrom": {},
                "bootVolume": {},
                "cpuFamily": "INTEL_ICELAKE",
                "type": "CUBE",
                "enabledFeatures": [
                  ""
                ],
                "placementGroupId": "",
                "nicMultiQueue": true,
                "maxNetworkBandwidth": 6
              },
              "entities": {
                "cdroms": {
                  "": ""
                },
                "volumes": {
                  "": ""
                },
                "nics": {
                  "": ""
                },
                "securitygroups": {
                  "": ""
                },
                "gpus": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "volumes": {
          "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",
                "type": "HDD",
                "size": 100,
                "availabilityZone": "AUTO",
                "image": "d6ad1576-fde9-4696-aa41-1ebd75bdaf49",
                "imagePassword": "mypass123",
                "sshKeys": [
                  ""
                ],
                "bus": "VIRTIO",
                "licenceType": "LINUX",
                "applicationType": "MSSQL-2019-Standard",
                "cpuHotPlug": true,
                "ramHotPlug": true,
                "nicHotPlug": true,
                "nicHotUnplug": true,
                "discVirtioHotPlug": true,
                "discVirtioHotUnplug": true,
                "exposeSerial": true,
                "requireLegacyBios": true,
                "deviceNumber": 3,
                "pciSlot": 7,
                "backupunitId": "25f67991-0f51-4efc-a8ad-ef1fb31a481c",
                "userData": "",
                "bootServer": "25f67991-0f51-4efc-a8ad-ef1fb31a481c",
                "bootOrder": "AUTO"
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "loadbalancers": {
          "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": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "lans": {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": {},
          "href": "<RESOURCE-URI>",
          "items": [
            {
              "id": "5",
              "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",
                "ipFailover": [
                  {
                    "": ""
                  }
                ],
                "ipv4CidrBlock": "10.8.130.0/23",
                "ipv6CidrBlock": "2001:db8:b06d:8f5a::/64",
                "pcc": "3c11273c-b3e1-4ca3-8134-84fd2dd4ebec",
                "public": true,
                "vni": 123
              },
              "entities": {
                "nics": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "networkloadbalancers": {
          "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 Network Load Balancer",
                "listenerLan": 1,
                "ips": [
                  ""
                ],
                "targetLan": 2,
                "lbPrivateIps": [
                  ""
                ],
                "centralLogging": true,
                "loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
              },
              "entities": {
                "flowlogs": {
                  "": ""
                },
                "forwardingrules": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "natgateways": {
          "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 NAT Gateway",
                "publicIps": [
                  ""
                ],
                "lans": [
                  {
                    "": ""
                  }
                ]
              },
              "entities": {
                "rules": {
                  "": ""
                },
                "flowlogs": {
                  "": ""
                }
              }
            }
          ],
          "offset": 0,
          "limit": 1000,
          "_links": {
            "prev": "<PREVIOUS-PAGE-URI>",
            "self": "<THIS-PAGE-URI>",
            "next": "<NEXT-PAGE-URI>"
          }
        },
        "securitygroups": {
          "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 security group",
                "description": "My security group description"
              },
              "entities": {
                "rules": {
                  "": ""
                },
                "nics": {
                  "": ""
                },
                "servers": {
                  "": ""
                }
              }
            }
          ],
          "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.