CLOUD API (5.0)

An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.

The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

swagger 2 Source url

Authentication

Basic Authentication

You will need to base64 encode the string containing your credentials. Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication

API key

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.


Server

List Attached Volumes

You can retrieve a list of volumes attached to the server


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

Retrieve an attached CD-ROM

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


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

List attached CD-ROMs

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


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

List Servers

You can retrieve a list of servers within a datacenter


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

Partially modify a Server

You can use update attributes of a server


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

Reboot a Server

This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.


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

Upgrade a Server

This will upgrade the version of the server, if needed. To verify if there is an upgrade available for a server, call '/datacenters/{datacenterId}/servers?upgradeNeeded=true'


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

Contract

Retrieve a Contract

Retrieves the attributes of user's contract.


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

Data Center

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

Nic

List Firewall Rules

Retrieves a list of firewall rules associated with a particular NIC


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

Create a Firewall Rule

This will add a Firewall Rule to the NIC


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

Delete a Firewall Rule

Removes the specific Firewall Rule


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

List Nics

Retrieves a list of NICs.


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

Create a Nic

Adds a NIC to the target server. Combine count of Nics and volumes attached to the server should not exceed size 24.


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

Retrieve a Nic

Retrieves the attributes of a given NIC


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

Modify a Nic

You can use update attributes of a Nic


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

Delete a Nic

Deletes the specified NIC.


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

Partially modify a Nic

You can use update attributes of a Nic


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

User Management

List All Groups.

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


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

Create a Group

You can use this POST method to create a group


post https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /um/groups/{groupId} Try out

Delete a Group

Delete a group


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

Retrieve resources assigned to a group

get https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /um/groups/{groupId}/shares 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/v5 /um/resources/{resourceType}/{resourceId} 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/v5 /um/resources/{resourceType} 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/v5 /um/resources Try out

List all Users

You can retrieve a complete list of users under your account


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

Create a user

You can use this POST method to create a user


post https://api.ionos.com/cloudapi/v5 /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/v5 /um/users/{userId} Try out

Modify a user

You can use update attributes of a User


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

Delete a User

Delete a user


delete https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /um/users/{userId}/owns Try out

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

Delete a S3 key

Delete a S3 key


delete https://api.ionos.com/cloudapi/v5 /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/v5 /um/users/{userId}/s3ssourl Try out

Image

List Images

Retrieve a list of images within the datacenter


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

Retrieve an Image

Retrieves the attributes of a given image.


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

Modify an Image

You can use update attributes of a resource


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

Partially modify an Image

You can use update attributes of a resource


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

IP Blocks

List IP Blocks

Retrieve a list of all reserved IP Blocks


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

Reserve IP Block

This will reserve a new IP Block


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

Retrieve an IP Block

Retrieves the attributes of a given IP Block.


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

Modify IP Block

You can use update attributes of a resource


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

Delete IP Block

Removes the specific IP Block


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

Partially modify IP Block

You can use update attributes of a resource


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

Lan

List Lans

Retrieve a list of LANs within the datacenter


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

Create a Lan

Creates a LAN within the datacenter


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

Retrieve a Lan

Retrieves the attributes of a given LAN


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

Modify a Lan

You can use update attributes of a resource


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

Delete a Lan.

Removes the specific Lan


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

Partially modify a Lan

You can use update attributes of a resource


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

Retrieve a nic attached to lan

This will retrieve the properties of an attached nic.


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

Load Balancer

List Load Balancers

Retrieve a list of Load Balancers within the datacenter


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

Create a Load Balancer

Creates a Loadbalancer within the datacenter


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

Retrieve a loadbalancer

Retrieves the attributes of a given Loadbalancer


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

Modify a Load Balancer

You can use update attributes of a resource


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

Delete a Loadbalancer.

Removes the specific Loadbalancer


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

Partially modify a Loadbalancer

You can use update attributes of a resource


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

List Load Balancer Members

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


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

Retrieve a nic attached to Load Balancer

This will retrieve the properties of an attached nic.


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

Detach a nic from loadbalancer

This will remove a nic from Load Balancer


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

Location

List Locations

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


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

List Locations within a region

Retrieve a list of Locations within a world's region


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

Retrieve a Location

Retrieves the attributes of a given location


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

Private Cross Connect

List Private Cross-Connects

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


get https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /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/v5 /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/v5 /pccs/{pccId} Try out

Request

Retrieve Request Status

Retrieves the status of a given request.


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

Retrieve a Request

Retrieves the attributes of a given request.


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

List Requests

Retrieve a list of API requests.


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

/

Display API information

Display API information


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

Snapshot

List Snapshots

Retrieve a list of available snapshots.


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

Retrieve a Snapshot by its uuid.

Retrieves the attributes of a given Snapshot.


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

Modify a Snapshot

You can use update attributes of a resource


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

Delete a Snapshot

Deletes the specified Snapshot.


delete https://api.ionos.com/cloudapi/v5 /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/v5 /snapshots/{snapshotId} Try out

Volume

List Volumes

Retrieves a list of Volumes.


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

Retrieve a Volume

Retrieves the attributes of a given Volume


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

Modify a Volume

You can use update attributes of a Volume


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

Partially modify a Volume

You can use update attributes of a Volume


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

Backup Unit

List Backup Units

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


get https://api.ionos.com/cloudapi/v5 /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/v5 /backupunits Try out

Returns the specified backup Unit

You can retrieve the details of an specific backup unit.


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

Modify a Backup Unit

You can use update a backup Unit properties


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

Partially modify a Backup Unit

You can use update a backup Unit properties


patch https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /backupunits/{backupunitId}/ssourl Try out

Label

List Labels

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


get https://api.ionos.com/cloudapi/v5 /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>:


get https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /snapshots/{snapshotId}/labels Try out

Add a Label to Snapshot

This will add a label to the snapshot.


post https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /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/v5 /ipblocks/{ipblockId}/labels/{key} 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/v5 /k8s Try out

Create Kubernetes Cluster

This will create a new Kubernetes Cluster.


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

Retrieve Kubernetes Cluster

This will retrieve a single Kubernetes Cluster.


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

Modify Kubernetes Cluster

This will modify the Kubernetes Cluster.


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

Delete Kubernetes Cluster

This will remove a Kubernetes Cluster.


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

Retrieve Kubernetes Configuration File

You can retrieve kubernetes configuration file for the kubernetes cluster.


get https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /k8s/{k8sClusterId}/nodepools Try out

Retrieve Kubernetes Node Pool

You can retrieve a single Kubernetes Node Pool.


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

Modify Kubernetes Node Pool

This will modify the Kubernetes Node Pool.


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

Delete Kubernetes Node Pool

This will remove a Kubernetes Node Pool.


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

Retrieve Kubernetes nodes.

You can retrieve all nodes of Kubernetes Node Pool.


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

Retrieve Kubernetes node

You can retrieve a single Kubernetes Node.


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

Delete Kubernetes node

This will remove a Kubernetes node.


delete https://api.ionos.com/cloudapi/v5 /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/v5 /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/v5 /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/v5 /k8s/versions/default Try out

Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster. (Deprecated)

You can retrieve a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.


get https://api.ionos.com/cloudapi/v5 /k8s/versions/{clusterVersion}/compatibilities Try out