CLOUD API (6.0-SDK.2)

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.

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


/

Display API information

Display API information


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

Data Centers

List Data Centers under your account

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

Locations

List Locations

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


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

List Locations within a region

Retrieve a list of Locations within a world's region


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

Retrieve a Location

Retrieves the attributes of a given location


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

Servers

List Servers

You can retrieve a list of servers within a datacenter


get https://api.ionos.com/cloudapi/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId} Try out

Modify a Server

Allows to modify the attributes of a Server. From v5 onwards 'allowReboot' attribute will no longer be available. For certain server property change it was earlier forced to be provided. Now this behaviour is implicit and backend will do this automatically e.g. in earlier versions, when CPU family changes, the 'allowReboot' property was required to be set to true which will no longer be the case and the server will be rebooted automatically


put https://api.ionos.com/cloudapi/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId} Try out

Partially modify a Server

You can use update attributes of a server


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

List Attached Volumes

You can retrieve a list of volumes attached to the server


get https://api.ionos.com/cloudapi/v6 /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/v6 /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/v6 /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/v6 /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/v6 /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/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} 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/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId}/stop Try out

Suspend a Cube Server

This will suspend a server. The operation can only be applied to Cube servers. Note: The virtual machine will not be deleted, and the consumed resources will continue to be billed.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/servers/{serverId}/suspend Try out

Resume a Cube Server

This will resume a suspended server. The operation can only be applied to suspended Cube servers. No billing event will be generated.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/servers/{serverId}/resume 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/v6 /datacenters/{datacenterId}/servers/{serverId}/upgrade Try out

Get the server's jwToken

Returns the server json web token to be used for login operations (ex: accessing the server console)


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

Get the server remote console link

Returns the link with the jwToken to access the server remote console


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

Images

List Images

Retrieve a list of images within the datacenter


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

Retrieve an Image

Retrieves the attributes of a given image.


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

Modify an Image

You can use update attributes of a resource


put https://api.ionos.com/cloudapi/v6 /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/v6 /images/{imageId} Try out

Partially modify an Image

You can use update attributes of a resource


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

Volumes

List Volumes

Retrieves a list of Volumes.


get https://api.ionos.com/cloudapi/v6 /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/v6 /datacenters/{datacenterId}/volumes Try out

Retrieve a Volume

Retrieves the attributes of a given Volume


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

Modify a Volume

You can use update attributes of a Volume


put https://api.ionos.com/cloudapi/v6 /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/v6 /datacenters/{datacenterId}/volumes/{volumeId} Try out

Partially modify a Volume

You can use update attributes of a volume.


patch https://api.ionos.com/cloudapi/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot Try out

Snapshots

List Snapshots

Retrieve a list of available snapshots.


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

Retrieve a Snapshot by its uuid.

Retrieves the attributes of a given Snapshot.


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

Modify a Snapshot

You can use update attributes of a resource.


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

Delete a Snapshot

Deletes the specified snapshot.


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

Partially modify a Snapshot

You can use this method to update attributes of a snapshot.


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

IP Blocks

List IP Blocks

Retrieve a list of all reserved IP Blocks.


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

Reserve IP Block

This will reserve a new IP Block.


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

Retrieve an IP Block

Retrieves the attributes of a given IP Block.


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

Modify IP Block

You can use update attributes of a resource.


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

Delete IP Block

Removes the specific IP Block.


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

Partially modify IP Block

You can use update attributes of a resource.


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

Lans

List Lans

Retrieve a list of LANs within the datacenter.


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

Create a Lan

Creates a LAN within the datacenter.


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

Retrieve a Lan

Retrieves the attributes of a given LAN.


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

Modify a Lan

You can use update attributes of a resource.


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

Delete a Lan.

Removes the specific LAN.


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

Partially modify a Lan

You can use update attributes of a resource.


patch https://api.ionos.com/cloudapi/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/lans/{lanId}/nics Try out

Retrieve a nic attached to lan

This will retrieve the properties of an attached network interface.


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

Network Interfaces

List Network Interfaces

Retrieves a list of network interfaces.


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

Create a Network Interface

Adds a network interface to the target server. Combined count of network interfaces and volumes attached to the server should not exceed size 24.


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

Retrieve a Network Interface

Retrieves the attributes of a given network interface.


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

Modify a Network Interface

You can use update attributes of a network interface.


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

Delete a Network Interface

Deletes the specified network interface.


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

Partially Modify a Network Interface

You can use update attributes of a network interface.


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

Firewall Rules

List Firewall Rules

Retrieves a list of firewall rules associated with a particular network interface.


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

Create a Firewall Rule

This will add a Firewall Rule to the network interface.


post https://api.ionos.com/cloudapi/v6 /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/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

Delete a Firewall Rule

Removes the specified firewall rule.


delete https://api.ionos.com/cloudapi/v6 /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/v6 /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} Try out

Flow Logs

List Flow Logs

Retrieves a list of Flow Logs associated with a particular network interface.


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

Create a Flow Log

This will add a Flow Log to the network interface.


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

Retrieve a Flow Log

Retrieves the attributes of a given Flow Log.


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

Modify a Flow Log

This will update a Flow Log record.


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

Partially update a Flow Log

This will partially update a Flow Log record.


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

Delete a Flow Log

Removes the specified Flow Log.


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

Load Balancers

List Load Balancers

Retrieve a list of Load Balancers within the datacenter.


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

Create a Load Balancer

Creates a Loadbalancer within the datacenter.


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

Retrieve a loadbalancer

Retrieves the attributes of a given load balancer.


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

Modify a Load Balancer

You can use update attributes of a resource.


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

Delete a Loadbalancer.

Removes the specified load balancer.


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

Partially modify a Loadbalancer

You can use update attributes of a resource.


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

List Load Balancer balaced NICs

You can retrieve a list of nics attached to a load balancer.


get https://api.ionos.com/cloudapi/v6 /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/v6 /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics Try out

Retrieve a network interface attached to Load Balancer

This will retrieve the properties of an attached network interface.


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

Detach a nic from loadbalancer

This will remove a network interface from load balancer.


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

NAT Gateways

List NAT Gateways

Retrieve a list of NAT Gateways within the datacenter.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways Try out

Create a NAT Gateway

Creates a NAT Gateway within the datacenter. User should be the contract owner or a admin or a user with createInternetAccess privilege


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways Try out

Retrieve a NAT gateway

Retrieves the attributes of a given NAT gateway.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId} Try out

Update a NAT gateway

Update the attributes of a given NAT gateway


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId} Try out

Partially update a NAT gateway

Partially update the attributes of a given NAT gateway


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId} Try out

Remove a NAT gateway

Removes the specified NAT gateway.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId} Try out

List NAT Gateways Rules

Retrieve a list of rules of a NAT Gateway within the datacenter.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules Try out

Create a NAT Gateway Rule

Creates a rule within the NAT Gateway of a datacenter.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules Try out

Retrieve a NAT Gateway Rule

Retrieves the attributes of a given NAT gateway rule.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} Try out

Modify a rule of the NAT gateway

You can use to update a rule of the NAT gateway.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} Try out

Partially modify a rule of the NAT gateway

You can use to partially update a rule of a NAT gateway.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} Try out

Remove rule from NAT Gateway

This will remove a rule from the NAT gateway.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId} Try out

List NAT Gateway Flow Logs

You can retrieve a list of Flow Logs of the NAT Gateway.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs Try out

Add a NAT Gateways Flow Log

This will add a new Flow Log to the NAT Gateway.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs Try out

Retrieve a Flow Log of the NAT Gateway

This will return a Flow Log of the NAT Gateway.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} Try out

Modify a Flow Log of the NAT Gateway

You can use to update a Flow Log of the NAT Gateway.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} Try out

Partially modify a Flow Log of the NAT Gateway

You can use to partially update a Flow Log of a NAT Gateway.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} Try out

Remove Flow Log from NAT Gateway

This will remove a flow log from the NAT gateway.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId} Try out

Network Load Balancers

List Network Load Balancers

Retrieve a list of Network Load Balancers within the datacenter.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers Try out

Create an Network Load Balancer

Creates an Network Load Balancer within the datacenter.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers Try out

Retrieve an Network Load Balancer

Retrieves the attributes of a given Network Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} Try out

Update an Network Load Balancer

Update the attributes of a given Network Load Balancer


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} Try out

Partially update an Network Load Balancer

Partially update the attributes of a given Network Load Balancer


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} Try out

Remove an Network Load Balancer

Removes the specified Network Load Balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId} Try out

List Network Load Balancer Flow Logs

You can retrieve a list of Flow Logs of the Network Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs Try out

Add a Network Load Balancer Flow Log

This will add a new Flow Log to the Network Load Balancer.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs Try out

Retrieve a Flow Log of the Network Load Balancer

This will return a Flow Log of the Network Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} Try out

Modify a Flow Log of the Network Load Balancer

You can use to update a Flow Log of the Network Load Balancer.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} Try out

Partially modify a Flow Log of the Network Load Balancer

You can use to partially update a Flow Log of a Network Load Balancer.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} Try out

Remove Flow Log from Network Load Balancer

This will remove a flow log from the network load balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId} Try out

List Network Load Balancer Forwarding Rules

You can retrieve a list of forwarding rules of the Network Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules Try out

Add a Network Load Balancer Forwarding Rule

This will add a new forwarding rule to the Network Load Balancer.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules Try out

Retrieve a Forwarding Rule of the Network Load Balancer

This will a forwarding rule of the Network Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Modify a forwarding rule of the Network Load Balancer

You can use to update a forwarding rule of the Network Load Balancer.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Partially modify a forwarding rule of the Network Load Balancer

You can use to partially update a forwarding rule of a Network Load Balancer.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Remove Forwarding Rule from Network Load Balancer

This will remove a forwarding rule from the Network Load Balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Application Load Balancers

List Application Load Balancers

Retrieve a list of Application Load Balancers within the datacenter.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers Try out

Create an Application Load Balancer

Creates an Application Load Balancer within the datacenter.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers Try out

Retrieve an Application Load Balancer

Retrieves the attributes of a given Application Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} Try out

Update an Application Load Balancer

Update the attributes of a given Application Load Balancer


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} Try out

Partially update an Application Load Balancer

Partially update the attributes of a given Application Load Balancer


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} Try out

Remove an Application Load Balancer

Removes the specified Application Load Balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} Try out

List Application Load Balancer Forwarding Rules

You can retrieve a list of forwarding rules of the Application Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules Try out

Add an Application Load Balancer Forwarding Rule

This will add a new forwarding rule to the Application Load Balancer.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules Try out

Retrieve a Forwarding Rule of the Application Load Balancer

This will a forwarding rule of the Application Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Modify a forwarding rule of the Application Load Balancer

You can use to update a forwarding rule of the Application Load Balancer.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Partially modify a forwarding rule of the Application Load Balancer

You can use to partially update a forwarding rule of an Application Load Balancer.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

Remove Forwarding Rule from Application Load Balancer

This will remove a forwarding rule from the Application Load Balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} Try out

List Application Load Balancer Flow Logs

You can retrieve a list of Flow Logs of the Application Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs Try out

Add a Application Load Balancer Flow Log

This will add a new Flow Log to the Application Load Balancer.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs Try out

Retrieve a Flow Log of the Application Load Balancer

This will return a Flow Log of the Application Load Balancer.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} Try out

Modify a Flow Log of the Application Load Balancer

You can use to update a Flow Log of the Application Load Balancer.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} Try out

Partially modify a Flow Log of the Application Load Balancer

You can use to partially update a Flow Log of a Application Load Balancer.


patch https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} Try out

Remove Flow Log from Application Load Balancer

This will remove a flow log from the application load balancer.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} Try out

Target Groups

List Target Groups

You can retrieve a list of all Target Groups.


get https://api.ionos.com/cloudapi/v6 /targetgroups Try out

Add a Target Group

This will add a new Target Group.


post https://api.ionos.com/cloudapi/v6 /targetgroups Try out

Retrieve a Target Group

Retrieves the attributes of a given Target Group.


get https://api.ionos.com/cloudapi/v6 /targetgroups/{targetGroupId} Try out

Update a Target Group

Update the attributes of a given Target Group


put https://api.ionos.com/cloudapi/v6 /targetgroups/{targetGroupId} Try out

Partially update a Target Group

Partially update the attributes of a given Target Group


patch https://api.ionos.com/cloudapi/v6 /targetgroups/{targetGroupId} Try out

Remove a Target Group

Removes the specified Target Group.


delete https://api.ionos.com/cloudapi/v6 /targetgroups/{targetGroupId} Try out

Requests

Retrieve a Request

Retrieves the attributes of a given request.


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

List Requests

Retrieve a list of API requests.


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

Retrieve Request Status

Retrieves the status of a given request.


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

Contract Resources

Retrieve a Contract

Retrieves the attributes of user's contract. In this version, the resource became a collection.


get https://api.ionos.com/cloudapi/v6 /contracts Try out

User Management

List all Users

You can retrieve a complete list of users under your account


get https://api.ionos.com/cloudapi/v6 /um/users Try out

Create a user

You can use this POST method to create a user


post https://api.ionos.com/cloudapi/v6 /um/users Try out

Retrieve a User

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/v6 /um/users/{userId} Try out

Modify a user

You can use update attributes of a User


put https://api.ionos.com/cloudapi/v6 /um/users/{userId} Try out

Delete a User

Delete a user


delete https://api.ionos.com/cloudapi/v6 /um/users/{userId} Try out

Retrieve a User's group resources

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/v6 /um/users/{userId}/groups Try out

Retrieve a User's own resources

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/v6 /um/users/{userId}/owns Try out

List All Groups.

You can retrieve a complete list of all groups that you have access to


get https://api.ionos.com/cloudapi/v6 /um/groups Try out

Create a Group

You can use this POST method to create a group


post https://api.ionos.com/cloudapi/v6 /um/groups Try out

Retrieve a Group

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/v6 /um/groups/{groupId} Try out

Modify a group

You can use this method to update properties of the group.


put https://api.ionos.com/cloudapi/v6 /um/groups/{groupId} Try out

Delete a Group

Delete a group


delete https://api.ionos.com/cloudapi/v6 /um/groups/{groupId} Try out

Retrieve resources assigned to a group

get https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/resources Try out

List Group Members

You can retrieve a list of users who are members of the group


get https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/users Try out

Add a user to a group

This will attach a pre-existing user to a group.


post https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/users Try out

Remove a user from a group

This will remove a user from a group.


delete https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/users/{userId} Try out

Retrieve a group share

This will retrieve the properties of a group share.


get https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/shares/{resourceId} Try out

Add a resource to a group

This will add a resource to the group.


post https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/shares/{resourceId} Try out

Modify resource permissions of a group

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/v6 /um/groups/{groupId}/shares/{resourceId} Try out

Remove a resource from a group

This will remove a resource from a group


delete https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/shares/{resourceId} Try out

List Group Shares

You can retrieve a list of all resources along with their permissions of the group


get https://api.ionos.com/cloudapi/v6 /um/groups/{groupId}/shares Try out

List All Resources.

You can retrieve a complete list of all resources that you have access to.


get https://api.ionos.com/cloudapi/v6 /um/resources Try out

Retrieve a list of Resources by type.

You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. 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/v6 /um/resources/{resourceType} Try out

Retrieve a Resource by type.

You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. 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/v6 /um/resources/{resourceType}/{resourceId} Try out

User S3 Keys

Retrieve a User's S3 keys

You can retrieve S3 keys owned by a user by using the users ID. This user Id 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/v6 /um/users/{userId}/s3keys Try out

Create a S3 Key for the given User

Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user


post https://api.ionos.com/cloudapi/v6 /um/users/{userId}/s3keys Try out

Retrieve given S3 Key belonging to the given User

You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user


get https://api.ionos.com/cloudapi/v6 /um/users/{userId}/s3keys/{keyId} Try out

Modify a S3 key having the given key id

You can enable or disable a given S3 key.


put https://api.ionos.com/cloudapi/v6 /um/users/{userId}/s3keys/{keyId} Try out

Delete an S3 Key

Delete an S3 key.


delete https://api.ionos.com/cloudapi/v6 /um/users/{userId}/s3keys/{keyId} Try out

Retrieve S3 object storage single signon URL for the given user

You can retrieve S3 object storage single signon URL for the given user. This user Id 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/v6 /um/users/{userId}/s3ssourl Try out

Backup Units

List Backup Units

You can retrieve a complete list of backup Units that you have access to.


get https://api.ionos.com/cloudapi/v6 /backupunits Try out

Create a Backup Unit

Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature


post https://api.ionos.com/cloudapi/v6 /backupunits Try out

Returns the specified Backup Unit

You can retrieve the details of an specific backup unit.


get https://api.ionos.com/cloudapi/v6 /backupunits/{backupunitId} Try out

Modify a Backup Unit

You can use update a Backup Unit properties.


put https://api.ionos.com/cloudapi/v6 /backupunits/{backupunitId} Try out

Partially modify a Backup Unit

You can use update a Backup Unit properties.


patch https://api.ionos.com/cloudapi/v6 /backupunits/{backupunitId} Try out

Delete a Backup Unit

NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit


delete https://api.ionos.com/cloudapi/v6 /backupunits/{backupunitId} Try out

Returns a single signon URL for the specified Backup Unit

Returns a single signon URL for the specified Backup Unit.


get https://api.ionos.com/cloudapi/v6 /backupunits/{backupunitId}/ssourl Try out

Kubernetes

List Kubernetes Clusters

You can retrieve a list of all kubernetes clusters associated with a contract


get https://api.ionos.com/cloudapi/v6 /k8s Try out

Create Kubernetes Cluster

This will create a new Kubernetes Cluster.


post https://api.ionos.com/cloudapi/v6 /k8s Try out

Retrieve Kubernetes Cluster

This will retrieve a single Kubernetes Cluster.


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId} Try out

Modify Kubernetes Cluster

This will modify the Kubernetes Cluster.


put https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId} Try out

Delete Kubernetes Cluster

This will remove a Kubernetes Cluster.


delete https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId} Try out

Retrieve Kubernetes Configuration File

You can retrieve kubernetes configuration file in YAML or JSON format for the kubernetes cluster. You can send the Accept header accordingly. Default Accept header is application/yaml


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/kubeconfig Try out

List Kubernetes Node Pools

You can retrieve a list of all kubernetes node pools part of kubernetes cluster


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools Try out

Create a Kubernetes Node Pool

This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.


post https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools Try out

Retrieve Kubernetes Node Pool

You can retrieve a single Kubernetes Node Pool.


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId} Try out

Modify Kubernetes Node Pool

This will modify the Kubernetes Node Pool.


put https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId} Try out

Delete Kubernetes Node Pool

This will remove a Kubernetes Node Pool.


delete https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId} Try out

Retrieve Kubernetes nodes.

You can retrieve all nodes of Kubernetes Node Pool.


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes Try out

Retrieve Kubernetes node

You can retrieve a single Kubernetes Node.


get https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} Try out

Delete Kubernetes node

This will remove a Kubernetes node.


delete https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} Try out

Recreate the Kubernetes node

You can recreate a single Kubernetes Node.


Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.


post https://api.ionos.com/cloudapi/v6 /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace Try out

Retrieve available Kubernetes versions

You can retrieve a list of available kubernetes versions


get https://api.ionos.com/cloudapi/v6 /k8s/versions Try out

Retrieve the current default kubernetes version for clusters and nodepools.

You can retrieve the current default kubernetes version for clusters and nodepools.


get https://api.ionos.com/cloudapi/v6 /k8s/versions/default Try out

Private Cross Connects

List Private Cross-Connects

You can retrieve a complete list of private cross-connects provisioned under your account


get https://api.ionos.com/cloudapi/v6 /pccs Try out

Create a Private Cross-Connect

You can use this POST method to create a private cross-connect.


post https://api.ionos.com/cloudapi/v6 /pccs Try out

Retrieve a Private Cross-Connect

You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.


get https://api.ionos.com/cloudapi/v6 /pccs/{pccId} Try out

Delete a Private Cross-Connect

Delete a private cross-connect if no datacenters are joined to the given PCC


delete https://api.ionos.com/cloudapi/v6 /pccs/{pccId} Try out

Partially Modify a Private Cross-Connect

You can use update private cross-connect to re-name or update its description


patch https://api.ionos.com/cloudapi/v6 /pccs/{pccId} Try out

Labels

List Labels

You can retrieve a complete list of labels that you have access to.


get https://api.ionos.com/cloudapi/v6 /labels Try out

Returns the label by its URN.

You can retrieve the details of a specific label using its URN. A URN is for uniqueness of a Label and composed using urn:label:<resource_type>:<resource_uuid>:<key>


get https://api.ionos.com/cloudapi/v6 /labels/{labelurn} Try out

List all Data Center Labels

You can retrieve a list of all labels associated with a data center.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/labels Try out

Add a Label to Data Center

This will add a label to the data center.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/labels Try out

Retrieve a Label of Data Center

This will retrieve the properties of a associated label to a data center.


get https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/labels/{key} Try out

Modify a Label of Data Center

This will modify the value of the label on a data center.


put https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/labels/{key} Try out

Delete a Label from Data Center

This will remove a label from the data center.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/labels/{key} Try out

List all Server Labels

You can retrieve a list of all labels associated with a server.


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

Add a Label to Server

This will add a label to the server.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/servers/{serverId}/labels Try out

Retrieve a Label of Server

This will retrieve the properties of a associated label to a server.


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

Modify a Label of Server

This will modify the value of the label on a server.


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

Delete a Label from Server

This will remove a label from the server.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/servers/{serverId}/labels/{key} Try out

List all Volume Labels

You can retrieve a list of all labels associated with a volume.


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

Add a Label to Volume

This will add a label to the volume.


post https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/volumes/{volumeId}/labels Try out

Retrieve a Label of Volume

This will retrieve the properties of a associated label to a volume.


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

Modify a Label of Volume

This will modify the value of the label on a volume.


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

Delete a Label from Volume

This will remove a label from the volume.


delete https://api.ionos.com/cloudapi/v6 /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} Try out

List all Snapshot Labels

You can retrieve a list of all labels associated with a snapshot.


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

Add a Label to Snapshot

This will add a label to the snapshot.


post https://api.ionos.com/cloudapi/v6 /snapshots/{snapshotId}/labels Try out

Retrieve a Label of Snapshot

This will retrieve the properties of a associated label to a snapshot.


get https://api.ionos.com/cloudapi/v6 /snapshots/{snapshotId}/labels/{key} Try out

Modify a Label of Snapshot

This will modify the value of the label on a snapshot.


put https://api.ionos.com/cloudapi/v6 /snapshots/{snapshotId}/labels/{key} Try out

Delete a Label from Snapshot

This will remove a label from the snapshot.


delete https://api.ionos.com/cloudapi/v6 /snapshots/{snapshotId}/labels/{key} Try out

List all Ip Block Labels

You can retrieve a list of all labels associated with a IP Block.


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

Add a Label to IP Block

This will add a label to the Ip Block.


post https://api.ionos.com/cloudapi/v6 /ipblocks/{ipblockId}/labels Try out

Retrieve a Label of IP Block

This will retrieve the properties of a associated label to a Ip Block.


get https://api.ionos.com/cloudapi/v6 /ipblocks/{ipblockId}/labels/{key} Try out

Modify a Label of IP Block

This will modify the value of the label on a Ip Block.


put https://api.ionos.com/cloudapi/v6 /ipblocks/{ipblockId}/labels/{key} Try out

Delete a Label from IP Block

This will remove a label from the Ip Block.


delete https://api.ionos.com/cloudapi/v6 /ipblocks/{ipblockId}/labels/{key} Try out

Templates

List Templates

Retrieve a list of available templates. Templates can be used on specific server types only (CUBE at the moment)


get https://api.ionos.com/cloudapi/v6 /templates Try out

Retrieve an available template

Retrieves the attributes of a given template.


get https://api.ionos.com/cloudapi/v6 /templates/{templateId} Try out