API How-Tos
The Cloud API lets you manage Cloud Cubes resources programmatically using conventional HTTP requests. All the functionality available in the IONOS Cloud Data Center Designer is also available through the API.
You can use the API to create, destroy, and retrieve information about your Cubes. You can also use the API to suspend or resume your Cubes.
However, not all actions are shared between Virtual Servers and Cloud Cubes. Since Cubes come with direct-attached storage, a composite call is required for setup.
Furthermore, when provisioning Cubes, Templates must be used. Templates will not be compatible with Servers that still support full flex configuration.
Cloud API outlines all required actions. | |
get
https://api.ionos.com/docs/cloud/v6/#tag/Templates
/cloudapi/v6/templates
Retrieve Template list
get
https://api.ionos.com/docs/cloud/v6/#tag/Templates
/cloudapi/v6/templates?depth=1
Retrieve Template details
A composite call doesn't only configure a single instance but also defines additional devices. This is required because a Cloud Cube must include a direct-attached storage device. An instance cannot be provisioned and then mounted with a direct-attached storage volume. Composite calls are used to execute a series of REST API requests into a single API call. You can use the output of one request as the input for a subsequent request.
The payload of a composite call to configure a Cubes instance is different from that of a
POST request to create an enterprise server. In a single request you can create a new instance, as well as its direct-attached storage device and image (public image, private image, or snapshot). When the request is processed, a Cubes instance is created and the direct-attached storage is mounted automatically.post
https://api.ionos.com/cloudapi
/v6/datacenter/{datacenterId}/servers
Create an instance
post
https://api.ionos.com/cloudapi
/v6/datacenters/{datacenterId}/servers/{serverId}/suspend
Suspend an instance
This does not destroy the instance. Used resources will be billed.
post
https://api.ionos.com/cloudapi
/v6/datacenters/{datacenterId}/servers/{serverId}/resume
Resume instance
delete
https://api.ionos.com/cloudapi
/v6/datacenters/{datacenterId}/servers/{serverId}
Delete instance
Deleting an instance also deletes the direct-attached storage NVMe volume. You should make a snapshot first in case you need to recreate the instance with the appropriate data device later.
Last modified 3mo ago