CLOUD API (3.0)

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.

swagger 2 Source url

Authentication

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 ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.


Server

List Attached Volumes

You can retrieve a list of volumes attached to the server


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/volumes Try out

Attach a volume

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/v3 /datacenters/{datacenterId}/servers/{serverId}/volumes Try out

Retrieve an attached volume

This will retrieve the properties of an attached volume.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} Try out

Detach a volume

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/v3 /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} Try out

List attached CD-ROMs

You can retrieve a list of CD-ROMs attached to the server.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/cdroms Try out

Attach a CD-ROM

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/v3 /datacenters/{datacenterId}/servers/{serverId}/cdroms Try out

Retrieve an attached CD-ROM

You can retrieve a specific CD-ROM attached to the server


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} Try out

Detach a CD-ROM

This will detach a CD-ROM from the server


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} Try out

List Servers

You can retrieve a list of servers within a datacenter


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers Try out

Create a Server

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/v3 /datacenters/{datacenterId}/servers Try out

Retrieve a Server

Returns information about a server such as its configuration, provisioning status, etc.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId} Try out

Modify a Server

You can use update attributes of a server


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId} Try out

Delete a Server

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/v3 /datacenters/{datacenterId}/servers/{serverId} Try out

Partially modify a Server

You can use update attributes of a server


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId} Try out

Reboot a Server

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/v3 /datacenters/{datacenterId}/servers/{serverId}/reboot Try out

Start a Server

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/v3 /datacenters/{datacenterId}/servers/{serverId}/start Try out

Stop a Server

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/v3 /datacenters/{datacenterId}/servers/{serverId}/stop Try out

Upgrade a Server

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/v3 /datacenters/{datacenterId}/servers/{serverId}/upgrade Try out

Data Center

List Data Centers

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/v3 /datacenters Try out

Create a Data Center

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/v3 /datacenters Try out

Retrieve a Data Center

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/v3 /datacenters/{datacenterId} Try out

Modify a Data Center

You can use update datacenter to re-name the datacenter or update its description


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId} Try out

Delete a Data Center

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/v3 /datacenters/{datacenterId} Try out

Partially modify a Data Center

You can use update datacenter to re-name the datacenter or update its description


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId} Try out

Nic

List Firewall Rules

Retrieves a list of firewall rules associated with a particular NIC


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules Try out

Create a Firewall Rule

This will add a Firewall Rule to the NIC


post https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules Try out

Retrieve a Firewall Rule

Retrieves the attributes of a given Firewall Rule.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

Modify a Firewall Rule

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

Delete a Firewall Rule

Removes the specific Firewall Rule


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

Partially modify a Firewall Rule

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

List Nics

Retrieves a list of NICs.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics Try out

Create a Nic

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/v3 /datacenters/{datacenterId}/servers/{serverId}/nics Try out

Retrieve a Nic

Retrieves the attributes of a given NIC


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} Try out

Modify a Nic

You can use update attributes of a Nic


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} Try out

Delete a Nic

Deletes the specified NIC.


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} Try out

Partially modify a Nic

You can use update attributes of a Nic


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} Try out

Image

List Images

Retrieve a list of images within the datacenter


get https://api.ionos.com/cloudapi/v3 /images Try out

Retrieve an Image

Retrieves the attributes of a given image.


get https://api.ionos.com/cloudapi/v3 /images/{imageId} Try out

Modify an Image

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /images/{imageId} Try out

Delete an Image

Deletes the specified image. This operation is permitted on private image only.


delete https://api.ionos.com/cloudapi/v3 /images/{imageId} Try out

Partially modify an Image

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /images/{imageId} Try out

IP Blocks

List IP Blocks

Retrieve a list of all reserved IP Blocks


get https://api.ionos.com/cloudapi/v3 /ipblocks Try out

Reserve IP Block

This will reserve a new IP Block


post https://api.ionos.com/cloudapi/v3 /ipblocks Try out

Retrieve an IP Block

Retrieves the attributes of a given IP Block.


get https://api.ionos.com/cloudapi/v3 /ipblocks/{ipblockId} Try out

Modify IP Block

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /ipblocks/{ipblockId} Try out

Delete IP Block

Removes the specific IP Block


delete https://api.ionos.com/cloudapi/v3 /ipblocks/{ipblockId} Try out

Partially modify IP Block

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /ipblocks/{ipblockId} Try out

Lan

List Lans

Retrieve a list of LANs within the datacenter


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans Try out

Create a Lan

Creates a LAN within the datacenter


post https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans Try out

Retrieve a Lan

Retrieves the attributes of a given LAN


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId} Try out

Modify a Lan

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId} Try out

Delete a Lan.

Removes the specific Lan


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId} Try out

Partially modify a Lan

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId} Try out

List Lan Members

You can retrieve a list of nics attached to a lan


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId}/nics Try out

Attach a nic

This will attach a pre-existing nic to a lan.


post https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId}/nics Try out

Retrieve a nic attached to lan

This will retrieve the properties of an attached nic.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId} Try out

Load Balancer

List Load Balancers

Retrieve a list of Load Balancers within the datacenter


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers Try out

Create a Load Balancer

Creates a Loadbalancer within the datacenter


post https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers Try out

Retrieve a loadbalancer

Retrieves the attributes of a given Loadbalancer


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} Try out

Modify a Load Balancer

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} Try out

Delete a Loadbalancer.

Removes the specific Loadbalancer


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} Try out

Partially modify a Loadbalancer

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} Try out

List Load Balancer Members

You can retrieve a list of nics attached to a Load Balancer


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics Try out

Attach a nic to Load Balancer

This will attach a pre-existing nic to a Load Balancer.


post https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics Try out

Retrieve a nic attached to Load Balancer

This will retrieve the properties of an attached nic.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} Try out

Detach a nic from loadbalancer

This will remove a nic from Load Balancer


delete https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} Try out

Location

List Locations

Retrieve a list of Locations. This list represents where you can provision your virtual data centers


get https://api.ionos.com/cloudapi/v3 /locations Try out

List Locations within a region

Retrieve a list of Locations within a world's region


get https://api.ionos.com/cloudapi/v3 /locations/{regionId} Try out

Retrieve a Location

Retrieves the attributes of a given location


get https://api.ionos.com/cloudapi/v3 /locations/{regionId}/{locationId} Try out

Request

Retrieve Request Status

Retrieves the status of a given request.


get https://api.ionos.com/cloudapi/v3 /requests/{requestId}/status Try out

Retrieve a Request

Retrieves the attributes of a given request.


get https://api.ionos.com/cloudapi/v3 /requests/{requestId} Try out

List Requests

Retrieve a list of API requests.


get https://api.ionos.com/cloudapi/v3 /requests Try out

/

Display API information

Display API information


get https://api.ionos.com/cloudapi/v3 / Try out

Snapshot

List Snapshots

Retrieve a list of available snapshots.


get https://api.ionos.com/cloudapi/v3 /snapshots Try out

Retrieve a Snapshot

Retrieves the attributes of a given Snapshot.


get https://api.ionos.com/cloudapi/v3 /snapshots/{snapshotId} Try out

Modify a Snapshot

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v3 /snapshots/{snapshotId} Try out

Delete a Snapshot

Deletes the specified Snapshot.


delete https://api.ionos.com/cloudapi/v3 /snapshots/{snapshotId} Try out

Partially modify a Snapshot

You can use update attributes of a resource


patch https://api.ionos.com/cloudapi/v3 /snapshots/{snapshotId} Try out

Volume

List Volumes

Retrieves a list of Volumes.


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/volumes Try out

Create a Volume

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/v3 /datacenters/{datacenterId}/volumes Try out

Retrieve a Volume

Retrieves the attributes of a given Volume


get https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/volumes/{volumeId} Try out

Modify a Volume

You can use update attributes of a Volume


put https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/volumes/{volumeId} Try out

Delete a Volume

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/v3 /datacenters/{datacenterId}/volumes/{volumeId} Try out

Partially modify a Volume

You can use update attributes of a Volume


patch https://api.ionos.com/cloudapi/v3 /datacenters/{datacenterId}/volumes/{volumeId} Try out

Restore Volume Snapshot

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/v3 /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot Try out

Create Volume Snapshot

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/v3 /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot Try out