ServersApi

ServersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

MethodHTTP requestDescription

DELETE /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}

Detach a CD-ROM by ID

GET /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}

Get Attached CD-ROM by ID

GET /datacenters/{datacenterId}/servers/{serverId}/cdroms

Get Attached CD-ROMs

POST /datacenters/{datacenterId}/servers/{serverId}/cdroms

Attach a CD-ROM

DELETE /datacenters/{datacenterId}/servers/{serverId}

Delete servers

GET /datacenters/{datacenterId}/servers/{serverId}

Retrieve servers by ID

GET /datacenters/{datacenterId}/servers

List servers

PATCH /datacenters/{datacenterId}/servers/{serverId}

Partially modify servers

POST /datacenters/{datacenterId}/servers

Create a Server

PUT /datacenters/{datacenterId}/servers/{serverId}

Modify a Server by ID

POST /datacenters/{datacenterId}/servers/{serverId}/reboot

Reboot servers

GET /datacenters/{datacenterId}/servers/{serverId}/remoteconsole

Get Remote Console link

POST /datacenters/{datacenterId}/servers/{serverId}/resume

Resume a Cube Server by ID

POST /datacenters/{datacenterId}/servers/{serverId}/start

Start an Enterprise Server by ID

POST /datacenters/{datacenterId}/servers/{serverId}/stop

Stop an Enterprise Server by ID

POST /datacenters/{datacenterId}/servers/{serverId}/suspend

Suspend a Cube Server by ID

GET /datacenters/{datacenterId}/servers/{serverId}/token

Get JASON Web Token

POST /datacenters/{datacenterId}/servers/{serverId}/upgrade

Upgrade a Server by ID

DELETE /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}

Detach a Volume by ID

GET /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}

Get Attached Volume by ID

GET /datacenters/{datacenterId}/servers/{serverId}/volumes

Get Attached Volumes

POST /datacenters/{datacenterId}/servers/{serverId}/volumes

Attach a Volume to a Server

datacenters_servers_cdroms_delete

datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Detach a CD-ROM by ID

Detachs the specified CD-ROM from the server. Detaching a CD-ROM deletes the CD-ROM. The image will not be deleted. Note that detaching a CD-ROM leads to a reset of the server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    cdrom_id = 'cdrom_id_example' # str | The unique ID of the CD-ROM.
    try:
        # Detach a CD-ROM by ID
        api_instance.datacenters_servers_cdroms_delete(datacenter_id, server_id, cdrom_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_cdroms_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

cdrom_id

str

The unique ID of the CD-ROM.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_cdroms_find_by_id

Image datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Get Attached CD-ROM by ID

Retrieves the properties of the CD-ROM attached to the specified server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    cdrom_id = 'cdrom_id_example' # str | The unique ID of the CD-ROM.
    try:
        # Get Attached CD-ROM by ID
        api_response = api_instance.datacenters_servers_cdroms_find_by_id(datacenter_id, server_id, cdrom_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_cdroms_find_by_id: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

cdrom_id

str

The unique ID of the CD-ROM.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Image

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_cdroms_get

Cdroms datacenters_servers_cdroms_get(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number, offset=offset, limit=limit)

Get Attached CD-ROMs

Lists all CD-ROMs attached to the specified server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Get Attached CD-ROMs 
        api_response = api_instance.datacenters_servers_cdroms_get(datacenter_id, server_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_cdroms_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

offset

int

The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).

[optional] [default to 0]

limit

int

The maximum number of elements to return (use together with offset for pagination).

[optional] [default to 1000]

Return type

Cdroms

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_cdroms_post

Image datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Attach a CD-ROM

Attachs a CD-ROM to an existing server specified by its ID. CD-ROMs cannot be created stand-alone like volumes. They are either attached to a server or do not exist. They always have an ISO-Image associated; empty CD-ROMs can not be provisioned. It is possible to attach up to two CD-ROMs to the same server. Note that attaching a CD-ROM leads to a reset of the server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    cdrom = ionoscloud.Image() # Image | The CD-ROM to be attached.
    try:
        # Attach a CD-ROM
        api_response = api_instance.datacenters_servers_cdroms_post(datacenter_id, server_id, cdrom)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_cdroms_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

cdrom

The CD-ROM to be attached.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Image

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_delete

datacenters_servers_delete(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number, delete_volumes=delete_volumes)

Delete servers

Delete the specified server in your data center. The attached storage volumes will also be removed if the query parameter is set to true otherwise a separate API call must be made for these actions.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Delete servers
        api_instance.datacenters_servers_delete(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

delete_volumes

bool

If true, all attached storage volumes will also be deleted.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_find_by_id

Server datacenters_servers_find_by_id(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Retrieve servers by ID

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

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Retrieve servers by ID
        api_response = api_instance.datacenters_servers_find_by_id(datacenter_id, server_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_find_by_id: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Server

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_get

Servers datacenters_servers_get(datacenter_id, pretty=pretty, depth=depth, upgrade_needed=upgrade_needed, x_contract_number=x_contract_number, offset=offset, limit=limit)

List servers

List all servers within the data center.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    try:
        # List servers 
        api_response = api_instance.datacenters_servers_get(datacenter_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

upgrade_needed

bool

Filter servers that can or that cannot be upgraded.

[optional]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

offset

int

The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).

[optional] [default to 0]

limit

int

The maximum number of elements to return (use together with offset for pagination).

[optional] [default to 1000]

Return type

Servers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_patch

Server datacenters_servers_patch(datacenter_id, server_id, server, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Partially modify servers

Update the properties of the specified server within the data center.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    server = ionoscloud.ServerProperties() # ServerProperties | The properties of the server to be updated.
    try:
        # Partially modify servers
        api_response = api_instance.datacenters_servers_patch(datacenter_id, server_id, server)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_patch: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

server

The properties of the server to be updated.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Server

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_post

Server datacenters_servers_post(datacenter_id, server, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create a Server

Creates a server within the specified data center. You can also use this request to configure the boot volumes and connect to existing LANs at the same time.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server = ionoscloud.Server() # Server | The server to create.
    try:
        # Create a Server
        api_response = api_instance.datacenters_servers_post(datacenter_id, server)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server

The server to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Server

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_put

Server datacenters_servers_put(datacenter_id, server_id, server, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a Server by ID

Modifies the properties of the specified server within the data center. Starting with v5, the 'allowReboot' attribute is retired; while previously required for changing certain server properties, this behavior is now implicit, and the backend will perform this automatically. For example, in earlier versions, when the CPU family is changed, 'allowReboot' had to be set to 'true'; this is no longer required, the reboot will be performed automatically.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    server = ionoscloud.Server() # Server | The modified server
    try:
        # Modify a Server by ID
        api_response = api_instance.datacenters_servers_put(datacenter_id, server_id, server)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_put: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

server

The modified server

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Server

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_reboot_post

datacenters_servers_reboot_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Reboot servers

Force a hard reboot of the specified server within the data center. Don't use this method if you wish to reboot gracefully. This is an equivalent of powering down a computer and turning it back on.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Reboot servers
        api_instance.datacenters_servers_reboot_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_reboot_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_remote_console_get

RemoteConsoleUrl datacenters_servers_remote_console_get(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Get Remote Console link

Retrieve a link with a JSON Web Token for accessing the server's Remote Console.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Get Remote Console link
        api_response = api_instance.datacenters_servers_remote_console_get(datacenter_id, server_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_remote_console_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

RemoteConsoleUrl

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_resume_post

datacenters_servers_resume_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Resume a Cube Server by ID

Resumes a suspended Cube Server specified by its ID. Since the suspended instance was not deleted the allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Resume a Cube Server by ID
        api_instance.datacenters_servers_resume_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_resume_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_start_post

datacenters_servers_start_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Start an Enterprise Server by ID

Starts the Enterprise Server specified by its ID. >Note that you cannot use this method to start a Cube Server. By starting the Enterprise Server, cores and RAM are provisioned, and the billing continues. If the server's public IPv4 address has been deallocated, a new IPv4 address will be assigned. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Start an Enterprise Server by ID
        api_instance.datacenters_servers_start_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_start_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_stop_post

datacenters_servers_stop_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Stop an Enterprise Server by ID

Stops the Enterprise Server specified by its ID. >Note that you cannot use this method to stop a Cube Server. By stopping the Enterprise Server, cores and RAM are freed and no longer charged. Public IPv4 IPs that are not reserved are returned to the IPv4 pool. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Stop an Enterprise Server by ID
        api_instance.datacenters_servers_stop_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_stop_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_suspend_post

datacenters_servers_suspend_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Suspend a Cube Server by ID

Suspends the specified Cubes instance within the data center. The instance is not deleted and allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Suspend a Cube Server by ID
        api_instance.datacenters_servers_suspend_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_suspend_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_token_get

Token datacenters_servers_token_get(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Get JASON Web Token

Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console).

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Get JASON Web Token
        api_response = api_instance.datacenters_servers_token_get(datacenter_id, server_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_token_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

Token

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_upgrade_post

datacenters_servers_upgrade_post(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Upgrade a Server by ID

Upgrades the server version.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # Upgrade a Server by ID
        api_instance.datacenters_servers_upgrade_post(datacenter_id, server_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_upgrade_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_volumes_delete

datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Detach a Volume by ID

Detachs the specified volume from the server. Note that only the volume's connection to the specified server is disconnected. If you want to delete the volume, you must submit a separate request to perform the deletion.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.ServersApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    try:
        # Detach a Volume by ID
        api_instance.datacenters_servers_volumes_delete(datacenter_id, server_id, volume_id)
    except ApiException as e:
        print('Exception when calling ServersApi.datacenters_servers_volumes_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

volume_id

str

The unique ID of the volume.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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

[optional] [default to 0]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_volumes_find_by_id

Volume datacenters_servers_volumes_find_by_id(datacenter_id, server_id, volume_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Get Attached Volume by ID

Retrieves the properties of the volume attached to the specified server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)