An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.
The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.
Basic Authentication
You will need to base64 encode the string containing your credentials. Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication
API key
Please provide header value as 'Bearer <token>' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.
You can retrieve a list of volumes attached to the server
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/volumes
Try out
This will attach a pre-existing storage volume to the server. It is also possible to create and attach a volume in one step just by providing a new volume description as payload. Combine count of Nics and volumes attached to the server should not exceed size 24.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/volumes
Try out
This will retrieve the properties of an attached volume.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Try out
This will detach the volume from the server. This will not delete the volume from your datacenter. You will need to make a separate request to perform a deletion
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Try out
You can retrieve a specific CD-ROM attached to the server
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Try out
This will detach a CD-ROM from the server
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Try out
You can retrieve a list of CD-ROMs attached to the server.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/cdroms
Try out
You can attach a CD-ROM to an existing server. You can attach up to 2 CD-ROMs to one server.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/cdroms
Try out
You can retrieve a list of servers within a datacenter
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers
Try out
Creates a server within an existing datacenter. You can configure the boot volume and connect the server to an existing LAN.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers
Try out
Returns information about a server such as its configuration, provisioning status, etc.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}
Try out
You can use update attributes of a server
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}
Try out
This will remove a server from your datacenter; however, it will not remove the storage volumes attached to the server. You will need to make a separate API call to perform that action
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}
Try out
You can use update attributes of a server
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}
Try out
This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/reboot
Try out
This will start a server. If the server's public IP was deallocated then a new IP will be assigned
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/start
Try out
This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated. The operation is not supported for Cube servers.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/stop
Try out
This will upgrade the version of the server, if needed. To verify if there is an upgrade available for a server, call '/datacenters/{datacenterId}/servers?upgradeNeeded=true'
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/upgrade
Try out
Retrieves the attributes of user's contract.
get
https://api.ionos.com/cloudapi/v4
/contracts
Try out
You can retrieve a list of data centers provisioned under your account. Default list will contain first 100 items. For more items use pagination query parameters
get
https://api.ionos.com/cloudapi/v4
/datacenters
Try out
Virtual data centers are the foundation of the platform. They act as logical containers for all other objects you will be creating, e.g. servers. You can provision as many data centers as you want. Datacenters have their own private network and are logically segmented from each other to create isolation. You can use this POST method to create a simple datacenter or to create a datacenter with multiple objects under it such as servers and storage volumes.
post
https://api.ionos.com/cloudapi/v4
/datacenters
Try out
You can retrieve a data center by using the resource's ID. This value can be found in the response body when a datacenter is created or when you GET a list of datacenters.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}
Try out
You can use update datacenter to re-name the datacenter or update its description
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}
Try out
Will remove all objects within the datacenter and remove the datacenter object itself, too. This is a highly destructive method which should be used with caution
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}
Try out
You can use update datacenter to re-name the datacenter or update its description
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}
Try out
Retrieves a list of firewall rules associated with a particular NIC
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
Try out
This will add a Firewall Rule to the NIC
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
Try out
Retrieves the attributes of a given Firewall Rule.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
Removes the specific Firewall Rule
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
You can use update attributes of a resource
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
Retrieves a list of NICs.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics
Try out
Adds a NIC to the target server. Combine count of Nics and volumes attached to the server should not exceed size 24.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics
Try out
Retrieves the attributes of a given NIC
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
You can use update attributes of a Nic
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
Deletes the specified NIC.
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
You can use update attributes of a Nic
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
You can retrieve a complete list of all groups that you have access to
get
https://api.ionos.com/cloudapi/v4
/um/groups
Try out
You can use this POST method to create a group
post
https://api.ionos.com/cloudapi/v4
/um/groups
Try out
You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
get
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}
Try out
You can use this method to update properties of the group.
put
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}
Try out
Delete a group
delete
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}
Try out
get
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/resources
Try out
You can retrieve a list of users who are members of the group
get
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/users
Try out
This will attach a pre-existing user to a group.
post
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/users
Try out
This will remove a user from a group
delete
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/users/{userId}
Try out
This will retrieve the properties of a group share.
get
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/shares/{resourceId}
Try out
This will add a resource to the group.
post
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/shares/{resourceId}
Try out
You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
put
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/shares/{resourceId}
Try out
This will remove a resource from a group
delete
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/shares/{resourceId}
Try out
You can retrieve a list of all resources along with their permissions of the group
get
https://api.ionos.com/cloudapi/v4
/um/groups/{groupId}/shares
Try out
You can retrieve a complete list of all resources that you have access to
get
https://api.ionos.com/cloudapi/v4
/um/resources
Try out
You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock }. The value of resource type can also be found in the response body when you GET a list of all resources.
get
https://api.ionos.com/cloudapi/v4
/um/resources/{resourceType}/{resourceId}
Try out
You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock }. This value of resource type also be found in the response body when you GET a list of all resources.
get
https://api.ionos.com/cloudapi/v4
/um/resources/{resourceType}
Try out
You can retrieve a complete list of users under your account
get
https://api.ionos.com/cloudapi/v4
/um/users
Try out
You can use this POST method to create a user
post
https://api.ionos.com/cloudapi/v4
/um/users
Try out
You can retrieve user details by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
get
https://api.ionos.com/cloudapi/v4
/um/users/{userId}
Try out
You can use update attributes of a User
put
https://api.ionos.com/cloudapi/v4
/um/users/{userId}
Try out
Delete a user
delete
https://api.ionos.com/cloudapi/v4
/um/users/{userId}
Try out
You can retrieve group resources of user by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
get
https://api.ionos.com/cloudapi/v4
/um/users/{userId}/groups
Try out
You can retrieve resources owned by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
get
https://api.ionos.com/cloudapi/v4
/um/users/{userId}/owns
Try out
Retrieve a list of images within the datacenter
get
https://api.ionos.com/cloudapi/v4
/images
Try out
Retrieves the attributes of a given image.
get
https://api.ionos.com/cloudapi/v4
/images/{imageId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/images/{imageId}
Try out
Deletes the specified image. This operation is permitted on private image only.
delete
https://api.ionos.com/cloudapi/v4
/images/{imageId}
Try out
You can use update attributes of a resource
patch
https://api.ionos.com/cloudapi/v4
/images/{imageId}
Try out
Retrieve a list of all reserved IP Blocks
get
https://api.ionos.com/cloudapi/v4
/ipblocks
Try out
This will reserve a new IP Block
post
https://api.ionos.com/cloudapi/v4
/ipblocks
Try out
Retrieves the attributes of a given IP Block.
get
https://api.ionos.com/cloudapi/v4
/ipblocks/{ipblockId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/ipblocks/{ipblockId}
Try out
Removes the specific IP Block
delete
https://api.ionos.com/cloudapi/v4
/ipblocks/{ipblockId}
Try out
You can use update attributes of a resource
patch
https://api.ionos.com/cloudapi/v4
/ipblocks/{ipblockId}
Try out
Retrieve a list of LANs within the datacenter
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans
Try out
Creates a LAN within the datacenter
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans
Try out
Retrieves the attributes of a given LAN
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}
Try out
Removes the specific Lan
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}
Try out
You can use update attributes of a resource
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}
Try out
You can retrieve a list of nics attached to a lan
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}/nics
Try out
This will attach a pre-existing nic to a lan.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}/nics
Try out
This will retrieve the properties of an attached nic.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}
Try out
Retrieve a list of Load Balancers within the datacenter
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers
Try out
Creates a Loadbalancer within the datacenter
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers
Try out
Retrieves the attributes of a given Loadbalancer
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
Removes the specific Loadbalancer
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
You can use update attributes of a resource
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
You can retrieve a list of nics attached to a Load Balancer
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics
Try out
This will attach a pre-existing nic to a Load Balancer.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics
Try out
This will retrieve the properties of an attached nic.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}
Try out
This will remove a nic from Load Balancer
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}
Try out
Retrieve a list of Locations. This list represents where you can provision your virtual data centers
get
https://api.ionos.com/cloudapi/v4
/locations
Try out
Retrieve a list of Locations within a world's region
get
https://api.ionos.com/cloudapi/v4
/locations/{regionId}
Try out
Retrieves the attributes of a given location
get
https://api.ionos.com/cloudapi/v4
/locations/{regionId}/{locationId}
Try out
Retrieves the status of a given request.
get
https://api.ionos.com/cloudapi/v4
/requests/{requestId}/status
Try out
Retrieves the attributes of a given request.
get
https://api.ionos.com/cloudapi/v4
/requests/{requestId}
Try out
Retrieve a list of API requests.
get
https://api.ionos.com/cloudapi/v4
/requests
Try out
Display API information
get
https://api.ionos.com/cloudapi/v4
/
Try out
Retrieve a list of available snapshots.
get
https://api.ionos.com/cloudapi/v4
/snapshots
Try out
Retrieves the attributes of a given Snapshot.
get
https://api.ionos.com/cloudapi/v4
/snapshots/{snapshotId}
Try out
You can use update attributes of a resource
put
https://api.ionos.com/cloudapi/v4
/snapshots/{snapshotId}
Try out
Deletes the specified Snapshot.
delete
https://api.ionos.com/cloudapi/v4
/snapshots/{snapshotId}
Try out
You can use this method to update attributes of a Snapshot.
patch
https://api.ionos.com/cloudapi/v4
/snapshots/{snapshotId}
Try out
Retrieves a list of Volumes.
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes
Try out
Creates a volume within the datacenter. This will not attach the volume to a server. Please see the Servers section for details on how to attach storage volumes
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes
Try out
Retrieves the attributes of a given Volume
get
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
You can use update attributes of a Volume
put
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
Deletes the specified volume. This will result in the volume being removed from your datacenter. Use this with caution.
delete
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
You can use update attributes of a Volume
patch
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create subsequent volumes if you want or to restore an existing volume.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot
Try out
Creates a snapshot of a volume within the datacenter. You can use a snapshot to create a new storage volume or to restore a storage volume.
post
https://api.ionos.com/cloudapi/v4
/datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot
Try out