IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the "Data Center Designer" (DCD) browser-based tool.
Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.
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.
Retrieves the API information such as API version.
get
https://api.ionos.com/cloudapi/v6
/
Try out
List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.
get
https://api.ionos.com/cloudapi/v6
/datacenters
Try out
Creates new data centers, and data centers that already contain elements, such as servers and storage volumes.
Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.
post
https://api.ionos.com/cloudapi/v6
/datacenters
Try out
Retrieve data centers by resource ID. This value is in the response body when the data center is created, and in the list of the data centers, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}
Try out
Modifies the properties of the specified data center, rename it, or change the description.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}
Try out
Delete the specified data center and all the elements it contains. This method is destructive and should be used carefully.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}
Try out
Updates the properties of the specified data center, rename it, or change the description.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}
Try out
Retrieves the available physical locations where you can deploy cloud resources in a VDC.
A location is identified by a combination of the following characters:
a two-character regionId, which represents a country (example: 'de')
a three-character locationId, which represents a city. The 'locationId' is typically based on the IATA code of the city's airport (example: 'txl').
Note that 'locations' are read-only and cannot be changed.
get
https://api.ionos.com/cloudapi/v6
/locations
Try out
Retrieves the available locations in a region specified by its ID. The 'regionId' consists of the two character identifier of the region (country), e.g., 'de'.
get
https://api.ionos.com/cloudapi/v6
/locations/{regionId}
Try out
Retrieves the information about the location specified by its ID. The 'locationId' consists of the three-digit identifier of the city according to the IATA code.
get
https://api.ionos.com/cloudapi/v6
/locations/{regionId}/{locationId}
Try out
List all servers within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers
Try out
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.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers
Try out
Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}
Try out
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.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}
Try out
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.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}
Try out
Update the properties of the specified server within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}
Try out
Lists all volumes attached to the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/volumes
Try out
Attachs an existing storage volume to the specified server.
You can attach an existing volume in the VDC to a server. To move a volume from one server to another, you must first detach the volume from the first server and attach it to the second server.
It is also possible to create and attach a volume in one step by simply providing a new volume description as a payload. The only difference is the URL; see 'Creating a Volume' for details about volumes.
Note that the combined total of attached volumes and NICs cannot exceed 24 per server.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/volumes
Try out
Retrieves the properties of the volume attached to the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Try out
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.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Try out
Lists all CD-ROMs attached to the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/cdroms
Try out
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.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/cdroms
Try out
Retrieves the properties of the CD-ROM attached to the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Try out
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.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Try out
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.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/reboot
Try out
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 thereby provisioned and the billing continues. In cases the server's public IP address has been deallocated, a new IP address will be assigned.
To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/start
Try out
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 thereby freed and no longer charged. Public IPs that are not reserved are returned to the IP pool.
To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/stop
Try out
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).
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/suspend
Try out
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).
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/resume
Try out
Upgrades the server version.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/upgrade
Try out
Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console).
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/token
Try out
Retrieve a link with a JSON Web Token for accessing the server's Remote Console.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/remoteconsole
Try out
List all the images within the data center.
get
https://api.ionos.com/cloudapi/v6
/images
Try out
Retrieve the properties of the specified image.
get
https://api.ionos.com/cloudapi/v6
/images/{imageId}
Try out
Modifies the properties of the specified image.
put
https://api.ionos.com/cloudapi/v6
/images/{imageId}
Try out
Delete the specified image; this operation is only supported for private images.
delete
https://api.ionos.com/cloudapi/v6
/images/{imageId}
Try out
Update the properties of the specified image.
patch
https://api.ionos.com/cloudapi/v6
/images/{imageId}
Try out
List all the volumes within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes
Try out
Creates a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes
Try out
Retrieve the properties of the specified volume within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
Modifies the properties of the specified volume within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
Delete the specified volume within the data center. Use with caution, the volume will be permanently removed!
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
Update the properties of the specified storage volume within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}
Try out
Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot
Try out
Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this volume.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot
Try out
List all available snapshots.
get
https://api.ionos.com/cloudapi/v6
/snapshots
Try out
Retrieve the properties of the specified snapshot.
get
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}
Try out
Modifies the properties of the specified snapshot.
put
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}
Try out
Deletes the specified snapshot.
delete
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}
Try out
Update the properties of the specified snapshot.
patch
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}
Try out
List all reserved IP blocks.
get
https://api.ionos.com/cloudapi/v6
/ipblocks
Try out
Reserves a new IP block.
post
https://api.ionos.com/cloudapi/v6
/ipblocks
Try out
Retrieve the properties of the specified IP block.
get
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}
Try out
Modifies the properties of the specified IP block.
put
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}
Try out
Remove the specified IP block.
delete
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}
Try out
Update the properties of the specified IP block.
patch
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}
Try out
List all LANs within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans
Try out
Creates a LAN within the data center.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans
Try out
Retrieve the properties of the specified LAN within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}
Try out
Modify the properties of the specified LAN within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}
Try out
Delete the specified LAN within the data center.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}
Try out
Update the properties of the specified LAN within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}
Try out
List all NICs, attached to the specified LAN.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}/nics
Try out
Attach an existing NIC to the specified LAN.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}/nics
Try out
Retrieve the properties of the NIC, attached to the specified LAN.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}
Try out
List all NICs, attached to the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics
Try out
Adds a NIC to the specified server. The combined total of NICs and attached volumes cannot exceed 24 per server.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics
Try out
Retrieve the properties of the specified NIC.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
Modify the properties of the specified NIC.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
Remove the specified NIC.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
Update the properties of the specified NIC.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Try out
List all firewall rules for the specified NIC.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
Try out
Creates a firewall rule for the specified NIC.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
Try out
Retrieve the properties of the specified firewall rule.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
Modifies the properties of the specified firewall rule.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
Delete the specified firewall rule.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
Update the properties of the specified firewall rule.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Try out
List all the Flow Logs for the specified NIC.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs
Try out
Adds a new Flow Log for the specified NIC.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs
Try out
Retrieve the properties of the specified Flow Log.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}
Try out
Modify the specified Flow Log record.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}
Try out
Update the specified Flow Log record.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}
Try out
Delete the specified Flow Log.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}
Try out
List all the Load Balancers within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers
Try out
Creates a Load Balancer within the data center.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers
Try out
Retrieve the properties of the specified Load Balancer within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
Modifies the properties of the specified Load Balancer within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
Remove the specified Load Balancer from the data center.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
Update the properties of the specified Load Balancer within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}
Try out
List all NICs, attached to the specified Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics
Try out
Attachs an existing NIC to the specified Load Balancer.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics
Try out
Retrieve the properties of the specified NIC, attached to the Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}
Try out
Detach the specified NIC from the Load Balancer.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}
Try out
List all NAT Gateways within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways
Try out
Creates a NAT Gateway within the data center.
This operation is restricted to contract owner, admin, and users with 'createInternetAccess' privileges.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways
Try out
Retrieve the properties of the specified NAT Gateway within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}
Try out
Modify the properties of the specified NAT Gateway within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}
Try out
Update the properties of the specified NAT Gateway within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}
Try out
Remove the specified NAT Gateway from the data center.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}
Try out
List all rules for the specified NAT Gateway.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules
Try out
Creates a rule for the specified NAT Gateway.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules
Try out
Retrieve the properties of the specified NAT Gateway rule.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Try out
Modify the specified NAT Gateway rule.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Try out
Updates the properties of the specified NAT Gateway rule.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Try out
Delete the specified NAT Gateway rule.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}
Try out
List all the Flow Logs for the specified NAT Gateway.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs
Try out
Adds a new Flow Log to the specified NAT Gateway.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs
Try out
Retrieve the specified NAT Gateway Flow Log.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Try out
Modify the specified NAT Gateway Flow Log.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Try out
Update the properties of the specified NAT Gateway Flow Log.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Try out
Delete the specified NAT Gateway Flow Log.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}
Try out
List all the Network Load Balancers within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers
Try out
Creates a Network Load Balancer within the data center.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers
Try out
Retrieve the properties of the specified Network Load Balancer within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Try out
Modify the properties of the specified Network Load Balancer within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Try out
Update the properties of the specified Network Load Balancer within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Try out
Remove the specified Network Load Balancer from the data center.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}
Try out
List all the Flow Logs for the specified Network Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
Try out
Adds a new Flow Log for the Network Load Balancer.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs
Try out
Retrieve the specified Network Load Balancer Flow Log.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Try out
Modify the specified Network Load Balancer Flow Log.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Try out
Update the properties of the specified Network Load Balancer Flow Log.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Try out
Delete the specified Network Load Balancer Flow Log.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}
Try out
List the forwarding rules for the specified Network Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
Try out
Creates a forwarding rule for the specified Network Load Balancer.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules
Try out
Retrieve the specified Network Load Balance forwarding rule.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Modify the specified Network Load Balancer forwarding rule.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Update the properties of the specified Network Load Balancer forwarding rule.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Delete the specified Network Load Balancer forwarding rule.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Lists all Application Load Balancers within a data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers
Try out
Creates an Application Load Balancer within the data center.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers
Try out
Retrieves the properties of the specified Application Load Balancer within the data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Try out
Modifies the properties of the specified Application Load Balancer within the data center.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Try out
Updates the properties of the specified Application Load Balancer within the data center.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Try out
Removes the specified Application Load Balancer from the data center.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Try out
Lists the forwarding rules of the specified Application Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules
Try out
Creates a forwarding rule for the specified Application Load Balancer.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules
Try out
Retrieves the Application Load Balancer forwarding rule specified by its ID.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Modifies the Application Load Balancer forwarding rule specified by its ID.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Updates the properties of the Application Load Balancer forwarding rule specified by its ID.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Deletes the Application Load Balancer forwarding rule specified by its ID.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Try out
Retrieves the flow logs for the specified Application Load Balancer.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs
Try out
Creates a flow log for the Application Load Balancer specified by ID.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs
Try out
Retrieves the Application Load Balancer flow log specified by its ID.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Try out
Modifies the Application Load Balancer flow log specified by its ID.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Try out
Updates the properties of the Application Load Balancer flow log specified by its ID.
patch
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Try out
Deletes the Application Load Balancer flow log specified by its ID.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Try out
Lists target groups.
A target group is a set of one or more registered targets. You must specify an IP address, a port number, and a weight for each target. Any object with an IP address in your VDC can be a target, for example, a VM, another load balancer, etc. You can register a target with multiple target groups.
get
https://api.ionos.com/cloudapi/v6
/targetgroups
Try out
Creates a target group.
post
https://api.ionos.com/cloudapi/v6
/targetgroups
Try out
Retrieves the properties of the target group specified by its ID.
get
https://api.ionos.com/cloudapi/v6
/targetgroups/{targetGroupId}
Try out
Modifies the properties of the target group specified by its ID.
put
https://api.ionos.com/cloudapi/v6
/targetgroups/{targetGroupId}
Try out
Updates the properties of the target group specified by its ID.
patch
https://api.ionos.com/cloudapi/v6
/targetgroups/{targetGroupId}
Try out
Deletes the target group specified by its ID.
delete
https://api.ionos.com/cloudapi/v6
/targetgroups/{targetGroupId}
Try out
Retrieve the properties of the specified request.
get
https://api.ionos.com/cloudapi/v6
/requests/{requestId}
Try out
List all API requests.
get
https://api.ionos.com/cloudapi/v6
/requests
Try out
Retrieve the status of the specified request.
get
https://api.ionos.com/cloudapi/v6
/requests/{requestId}/status
Try out
Retrieves the properties of the user's contract. This operation allows you to obtain the resource limits and the general contract information.
get
https://api.ionos.com/cloudapi/v6
/contracts
Try out
List all the users in your account.
get
https://api.ionos.com/cloudapi/v6
/um/users
Try out
Create a user.
post
https://api.ionos.com/cloudapi/v6
/um/users
Try out
Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}
Try out
Modify the properties of the specified user.
put
https://api.ionos.com/cloudapi/v6
/um/users/{userId}
Try out
Delete the specified user.
delete
https://api.ionos.com/cloudapi/v6
/um/users/{userId}
Try out
Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/groups
Try out
Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/owns
Try out
List all the available user groups.
get
https://api.ionos.com/cloudapi/v6
/um/groups
Try out
Create a group.
post
https://api.ionos.com/cloudapi/v6
/um/groups
Try out
Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}
Try out
Modify the properties of the specified group.
put
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}
Try out
Remove the specified group.
delete
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}
Try out
List the resources assigned to the group, by group ID.
get
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/resources
Try out
List all members of the specified user group.
get
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/users
Try out
Adds an existing user to the specified group.
post
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/users
Try out
Remove the specified user from the group.
delete
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/users/{userId}
Try out
Retrieve the properties of the specified group share.
get
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/shares/{resourceId}
Try out
Add the specified share to the group.
post
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/shares/{resourceId}
Try out
Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
put
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/shares/{resourceId}
Try out
Remove the specified share from the group.
delete
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/shares/{resourceId}
Try out
List all shares and share privileges for the specified group.
get
https://api.ionos.com/cloudapi/v6
/um/groups/{groupId}/shares
Try out
List all the available resources.
get
https://api.ionos.com/cloudapi/v6
/um/resources
Try out
List all resources of the specified type.
Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s}
Resource types are in the list of resources, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/resources/{resourceType}
Try out
Retrieve a resource by the resource type and resource ID.
Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s}
Resource types are in the list of resources, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/resources/{resourceType}/{resourceId}
Try out
List S3 keys by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3keys
Try out
Create an S3 key for the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. A maximum of five keys per user can be generated.
post
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3keys
Try out
Retrieve the specified user S3 key. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. The key ID is in the response body when the S3 key is created, and in the list of all user S3 keys, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3keys/{keyId}
Try out
Enables or disables the specified user S3 key.
put
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3keys/{keyId}
Try out
Delete the specified user S3 key.
delete
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3keys/{keyId}
Try out
Retrieve S3 Object Storage single sign-on URLs for the the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/um/users/{userId}/s3ssourl
Try out
List all available backup units.
get
https://api.ionos.com/cloudapi/v6
/backupunits
Try out
Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management.
post
https://api.ionos.com/cloudapi/v6
/backupunits
Try out
Retrieve the properties of the specified backup unit.
get
https://api.ionos.com/cloudapi/v6
/backupunits/{backupunitId}
Try out
Modify the properties of the specified backup unit.
put
https://api.ionos.com/cloudapi/v6
/backupunits/{backupunitId}
Try out
Update the properties of the specified backup unit.
patch
https://api.ionos.com/cloudapi/v6
/backupunits/{backupunitId}
Try out
Remove the specified backup unit.
This process will delete:
- The backup plans inside the backup unit
- All backups, associated with this backup unit
- The backup user
- The backup unit itself
delete
https://api.ionos.com/cloudapi/v6
/backupunits/{backupunitId}
Try out
Retrieve a single sign-on URL for the specified backup unit.
get
https://api.ionos.com/cloudapi/v6
/backupunits/{backupunitId}/ssourl
Try out
List all available Kubernetes clusters.
get
https://api.ionos.com/cloudapi/v6
/k8s
Try out
Creates a Kubernetes cluster.
post
https://api.ionos.com/cloudapi/v6
/k8s
Try out
Retrieve the specified Kubernetes cluster.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}
Try out
Modifies the specified Kubernetes cluster.
put
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}
Try out
Delete the specified Kubernetes cluster.
delete
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}
Try out
Retrieve a configuration file for the specified Kubernetes cluster, in YAML or JSON format as defined in the Accept header; the default Accept header is application/yaml.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/kubeconfig
Try out
List all Kubernetes node pools, included the specified Kubernetes cluster.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools
Try out
Create a Kubernetes node pool inside the specified Kubernetes cluster.
post
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools
Try out
Retrieve the specified Kubernetes node pool.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}
Try out
Modifies the specified Kubernetes node pool.
put
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}
Try out
Delete the specified Kubernetes node pool.
delete
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}
Try out
List all the nodes, included in the specified Kubernetes node pool.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes
Try out
Retrieve the specified Kubernetes node.
get
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Try out
Delete the specified Kubernetes node.
delete
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Try out
Recreate the specified Kubernetes node.
A new node is created and configured by Managed Kubernetes, based on the node pool template. Once the status is "Active", all the pods are migrated from the faulty node, which is then deleted once empty. During this operation, the node pool will have an additional billable "Active" node.
post
https://api.ionos.com/cloudapi/v6
/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace
Try out
List available Kubernetes versions.
get
https://api.ionos.com/cloudapi/v6
/k8s/versions
Try out
Retrieve current default Kubernetes version for clusters and nodepools.
get
https://api.ionos.com/cloudapi/v6
/k8s/versions/default
Try out
List all private Cross-Connects for your account.
get
https://api.ionos.com/cloudapi/v6
/pccs
Try out
Creates a private Cross-Connect.
post
https://api.ionos.com/cloudapi/v6
/pccs
Try out
Retrieve a private Cross-Connect by the resource ID. Cross-Connect ID is in the response body when the private Cross-Connect is created, and in the list of private Cross-Connects, returned by GET.
get
https://api.ionos.com/cloudapi/v6
/pccs/{pccId}
Try out
Remove the specified private Cross-Connect (only if not connected to any data centers).
delete
https://api.ionos.com/cloudapi/v6
/pccs/{pccId}
Try out
Update the properties of the specified private Cross-Connect.
patch
https://api.ionos.com/cloudapi/v6
/pccs/{pccId}
Try out
List all available labels.
get
https://api.ionos.com/cloudapi/v6
/labels
Try out
Retrieve a label by label URN.
The URN is unique for each label, and consists of:
urn:label:<resource_type>:<resource_uuid>:
get
https://api.ionos.com/cloudapi/v6
/labels/{labelurn}
Try out
List all the the labels for the specified data center.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/labels
Try out
Adds a new label to the specified data center.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/labels
Try out
Retrieve the properties of the specified data center label.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/labels/{key}
Try out
Modifies the specified data center label.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/labels/{key}
Try out
Delete the specified data center label.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/labels/{key}
Try out
List all the the labels for the specified server.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/labels
Try out
Adds a new label to the specified server.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/labels
Try out
Retrieve the properties of the specified server label.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/labels/{key}
Try out
Modifies the specified server label.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/labels/{key}
Try out
Delete the specified server label.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/servers/{serverId}/labels/{key}
Try out
List all the the labels for the specified volume.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/labels
Try out
Adds a new label to the specified volume.
post
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/labels
Try out
Retrieve the properties of the specified volume label.
get
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}
Try out
Modifies the specified volume label.
put
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}
Try out
Delete the specified volume label.
delete
https://api.ionos.com/cloudapi/v6
/datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}
Try out
List all the the labels for the specified snapshot.
get
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}/labels
Try out
Adds a new label to the specified snapshot.
post
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}/labels
Try out
Retrieve the properties of the specified snapshot label.
get
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}/labels/{key}
Try out
Modifies the specified snapshot label.
put
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}/labels/{key}
Try out
Delete the specified snapshot label.
delete
https://api.ionos.com/cloudapi/v6
/snapshots/{snapshotId}/labels/{key}
Try out
List all the the labels for the specified IP block.
get
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}/labels
Try out
Add a new label to the specified IP block.
post
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}/labels
Try out
Retrieve the properties of the specified IP block label.
get
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}/labels/{key}
Try out
Modifies the specified IP block label.
put
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}/labels/{key}
Try out
Delete the specified IP block label.
delete
https://api.ionos.com/cloudapi/v6
/ipblocks/{ipblockId}/labels/{key}
Try out
Retrieves all available templates.
Templates provide a pre-defined configuration for Cube servers.
Templates are read-only and cannot be created, modified, or deleted by users.
get
https://api.ionos.com/cloudapi/v6
/templates
Try out
Retrieves the properties of the Cubes template specified by its ID.
get
https://api.ionos.com/cloudapi/v6
/templates/{templateId}
Try out