Retrieve servers by ID

1 min

GET

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

Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on.

Path Parameters

datacenterIdstringrequired
Description
The unique ID of the data center.
serverIdstringrequired
Description
The unique ID of the server.

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

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

Server
- 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
      - idstringrequired
        Description
        The resource's unique identifier.
      - typeobject
        Type
      - hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
  - bootVolumeobject
    - ResourceReference
      - idstringrequired
        Description
        The resource's unique identifier.
      - typeobject
        Type
      - hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
  - 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
    - 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
    - itemsImage[]
      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
      - propertiesImagePropertiesrequired
        namestring
        Example
        My resource
        Description
        The resource name.
        descriptionstring
        Example
        The image/snapshot of Ubuntu
        Description
        Human-readable description.
        locationstring
        Example
        us/las
        Description
        The location of this image/snapshot.
        sizenumber
        Example
        100
        Description
        The image size in GB.
        cpuHotPlugboolean
        Example
        true
        Description
        Hot-plug capable CPU (no reboot required).
        cpuHotUnplugboolean
        Example
        true
        Description
        Hot-unplug capable CPU (no reboot required).
        ramHotPlugboolean
        Example
        true
        Description
        Hot-plug capable RAM (no reboot required).
        ramHotUnplugboolean
        Example
        true
        Description
        Hot-unplug 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.
        discScsiHotPlugboolean
        Example
        true
        Description
        Hot-plug capable SCSI drive (no reboot required).
        discScsiHotUnplugboolean
        Example
        true
        Description
        Hot-unplug capable SCSI 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
        requireLegacyBiosRequireLegacyBios
        Example
        true
        Description
        Indicates if the image requires the legacy BIOS for compatibility or specific needs.
        Default
        true
        licenceTypestringrequired
        Example
        LINUX
        Description
        The OS type of this image.
        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.
        imageTypestring<HDD | CDROM | UNKNOWN>
        Example
        HDD
        Description
        The image type.
        Allowed
        HDDCDROMUNKNOWN
        publicboolean
        Example
        true
        Description
        Indicates whether the image is part of a public repository.
        imageAliasesstring[]
        Description
        List of image aliases mapped for this image
        requiredFeaturesstring[]
        Description
        The list of features required by this image. If SEV-SNP is part of this list, then the image supports Confidential Computing.
        cloudInitstring<NONE | V1>
        Example
        V1
        Description
        Cloud init compatibility.
        Allowed
        NONEV1
    - 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
  - volumesAttachedVolumes
    - 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
    - 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.
        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
        requireLegacyBiosRequireLegacyBios
        Example
        true
        Description
        Indicates if the image requires the legacy BIOS for compatibility or specific needs.
        Default
        true
        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
  - nicsNics
    - idstring
      Example
      15f67991-0f51-4efc-a8ad-ef1fb31a480c
      Description
      The resource's unique identifier.
    - typeobject
      - Type
    - hrefstring<uri>
      Example
      <RESOURCE-URI>
      Description
      URL to the object representation (absolute path).
      Format
      uri
    - itemsNic[]
      Description
      Array of items in the collection.
      - idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
      - typeobject
        Type
      - hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
      - metadataDatacenterElementMetadata
        etagstring
        Example
        45480eb3fbfc31f1d916c1eaa4abdcc3
        Description
        Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
        createdDatestring<date-time>
        Example
        2015-12-04T14:34:09.809Z
        Description
        The last time the resource was created.
        Format
        date-time
        createdBystring
        Example
        [email protected]
        Description
        The user who created the resource.
        createdByUserIdstring
        Example
        [email protected]
        Description
        The unique ID of the user who created the resource.
        lastModifiedDatestring<date-time>
        Example
        2015-12-04T14:34:09.809Z
        Description
        The last time the resource was modified.
        Format
        date-time
        lastModifiedBystring
        Example
        [email protected]
        Description
        The user who last modified the resource.
        lastModifiedByUserIdstring
        Example
        63cef532-26fe-4a64-a4e0-de7c8a506c90
        Description
        The unique ID of the user who last modified the resource.
        statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
        Example
        AVAILABLE
        Description
        State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
        Allowed
        AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
      - propertiesNicPropertiesrequired
        namestring
        Example
        My resource
        Description
        The name of the resource.
        macstring
        Example
        00:0a:95:9d:68:16
        Description
        The MAC address of the NIC.
        ipsstring[]
        Example
        [ "10.160.12.12" ]
        Description
        Collection of IP addresses, assigned to the NIC. Explicitly assigned public IPs need to come from reserved IP blocks. Passing value null or empty array will assign an IP address automatically.
        dhcpboolean
        Example
        true
        Description
        Indicates if the NIC will reserve an IP using DHCP.
        Default
        true
        ipv6Ipsstring[]
        Example
        [ "2001:db8:b06d:8f5a:0609::1" ]
        Description
        If this NIC is connected to an IPv6 enabled LAN then this property contains the IPv6 IP addresses of the NIC. The maximum number of IPv6 IP addresses per NIC is 50, if you need more, contact support. If you leave this property 'null' when adding a NIC, when changing the NIC's IPv6 CIDR block, when changing the LAN's IPv6 CIDR block or when moving the NIC to a different IPv6 enabled LAN, then we will automatically assign the same number of IPv6 addresses which you had before from the NICs new CIDR block. If you leave this property 'null' while not changing the CIDR block, the IPv6 IP addresses won't be changed either. You can also provide your own self choosen IPv6 addresses, which then must be inside the IPv6 CIDR block of this NIC.
        ipv6CidrBlockstring
        Example
        2001:db8:b06d:8f5a:0609::/80
        Description
        If this NIC is connected to an IPv6 enabled LAN then this property contains the /80 IPv6 CIDR block of the NIC. If you leave this property 'null' when adding a NIC to an IPv6-enabled LAN, then an IPv6 CIDR block will automatically be assigned to the NIC, but you can also specify an /80 IPv6 CIDR block for the NIC on your own, which must be inside the /64 IPv6 CIDR block of the LAN and unique. This value can only be set, if the LAN already has an IPv6 CIDR block assigned. An IPv6-enabled LAN is limited to a maximum of 65,536 NICs.
        dhcpv6boolean
        Example
        true
        Description
        Indicates if the NIC will receive an IPv6 using DHCP. It can be set to 'true' or 'false' only if this NIC is connected to an IPv6 enabled LAN.
        Default
        true
        laninteger<int32>required
        Example
        2
        Description
        The LAN ID the NIC will be on. If the LAN ID does not exist, it will be implicitly created.
        Format
        int32
        firewallActiveboolean
        Description
        Activate or deactivate the firewall. By default, an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, IP addresses and ports.
        firewallTypestring<INGRESS | EGRESS | BIDIRECTIONAL>
        Example
        INGRESS
        Description
        The type of firewall rules that will be allowed on the NIC. If not specified, the default INGRESS value is used.
        Allowed
        INGRESSEGRESSBIDIRECTIONAL
        deviceNumberinteger<int32>
        Example
        3
        Description
        The Logical Unit Number (LUN) of the storage volume. Null if this NIC was created using Cloud API and no DCD changes were performed on the Datacenter.
        Format
        int32
        pciSlotinteger<int32>
        Example
        7
        Description
        The PCI slot number for the NIC.
        Format
        int32
        vnetstring
        Description
        The vnet ID that belongs to this NIC; Requires system privileges, for internal usage only
      - entitiesNicEntities
        flowlogsFlowLogs
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        The URL to the object representation (absolute path).
        Format
        uri
        itemsFlowLog[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        Max depth limit reached
        firewallrulesFirewallRules
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
        itemsFirewallRule[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        Max depth limit reached
        securitygroupsSecurityGroups
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        The URL to the object representation (absolute path).
        Format
        uri
        itemsSecurityGroup[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        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
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
        itemsFirewallRule[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        Max depth limit reached
        nicsNics
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
        itemsNic[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        Max depth limit reached
        serversServers
        idstring
        Example
        15f67991-0f51-4efc-a8ad-ef1fb31a480c
        Description
        The resource's unique identifier.
        typeobject
        Type
        Max depth limit reached
        hrefstring<uri>
        Example
        <RESOURCE-URI>
        Description
        URL to the object representation (absolute path).
        Format
        uri
        itemsServer[]
        Description
        Array of items in the collection.
        Max depth limit reached
        offsetPaginationOffsetOptional
        Description
        The offset (if specified in the request).
        Max depth limit reached
        limitPaginationLimitOptional
        Example
        1000
        Description
        The limit (if specified in the request).
        Max depth limit reached
        _linksPaginationLinks
        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
  - gpusGPUs
    - idstring
      Example
      25f67991-0f51-4efc-a8ad-ef1fb31a400c
      Description
      The resource's unique identifier.
    - typeobject
      - Type
    - hrefstring<uri>
      Example
      <RESOURCE-URI>
      Description
      The URL to the object representation (absolute path).
      Format
      uri
    - itemsGPU[]
      Description
      Array of items in the collection.
      - idstring
        Example
        25f67991-0f51-4efc-a8ad-ef1fb31a400c
        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
      - propertiesGPUPropertiesrequired
        namestring
        Example
        My GPU
        Description
        The name of the resource.
        Max Length
        255
        vendorstring
        Example
        NVIDIA
        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.
        modelstring
        Example
        A100
        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.
        typestring
        Example
        passthrough
        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).
    - offsetPaginationOffsetOptional
      Description
      The offset (if specified in the request).
    - limitPaginationLimitOptional
      Example
      1000
      Description
      The limit (if specified in the request).
    - _linksPaginationLinks
      - prevstring<uri>
        Example
        <PREVIOUS-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0.
        Format
        uri
      - selfstring<uri>
        Example
        <THIS-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the current page.
        Format
        uri
      - nextstring<uri>
        Example
        <NEXT-PAGE-URI>
        Description
        URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements.
        Format
        uri

Response Headers

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

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

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

curl

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

javascript

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

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

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

ruby

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

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

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

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

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

python

import requests
import json

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

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>",
  "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": {
      "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",
            "description": "The image/snapshot of Ubuntu ",
            "location": "us/las",
            "size": 100,
            "cpuHotPlug": true,
            "cpuHotUnplug": true,
            "ramHotPlug": true,
            "ramHotUnplug": true,
            "nicHotPlug": true,
            "nicHotUnplug": true,
            "discVirtioHotPlug": true,
            "discVirtioHotUnplug": true,
            "discScsiHotPlug": true,
            "discScsiHotUnplug": true,
            "exposeSerial": true,
            "requireLegacyBios": true,
            "licenceType": "LINUX",
            "applicationType": "MSSQL-2019-Standard",
            "imageType": "HDD",
            "public": true,
            "imageAliases": [
              ""
            ],
            "requiredFeatures": [
              ""
            ],
            "cloudInit": "V1"
          }
        }
      ],
      "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>"
      }
    },
    "nics": {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": {},
      "href": "<RESOURCE-URI>",
      "items": [
        {
          "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
          "type": {},
          "href": "<RESOURCE-URI>",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "My resource",
            "mac": "00:0a:95:9d:68:16",
            "ips": [
              ""
            ],
            "dhcp": true,
            "ipv6Ips": [
              ""
            ],
            "ipv6CidrBlock": "2001:db8:b06d:8f5a:0609::/80",
            "dhcpv6": true,
            "lan": 2,
            "firewallActive": false,
            "firewallType": "INGRESS",
            "deviceNumber": 3,
            "pciSlot": 7,
            "vnet": ""
          },
          "entities": {
            "flowlogs": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            },
            "firewallrules": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            },
            "securitygroups": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            }
          }
        }
      ],
      "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": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            },
            "nics": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            },
            "servers": {
              "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
              "type": {},
              "href": "<RESOURCE-URI>",
              "items": [
                {
                  "": ""
                }
              ],
              "offset": 0,
              "limit": 1000,
              "_links": {
                "": ""
              }
            }
          }
        }
      ],
      "offset": 0,
      "limit": 1000,
      "_links": {
        "prev": "<PREVIOUS-PAGE-URI>",
        "self": "<THIS-PAGE-URI>",
        "next": "<NEXT-PAGE-URI>"
      }
    },
    "gpus": {
      "id": "25f67991-0f51-4efc-a8ad-ef1fb31a400c",
      "type": {},
      "href": "<RESOURCE-URI>",
      "items": [
        {
          "id": "25f67991-0f51-4efc-a8ad-ef1fb31a400c",
          "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 GPU",
            "vendor": "NVIDIA",
            "model": "A100",
            "type": "passthrough"
          }
        }
      ],
      "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.