CLOUD API (6.0-SDK.2)
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.
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.
/
Data Centers
List Data Centers under your account
You can retrieve a complete list of data centers provisioned under your account
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.
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.
Modify a Data Center
You can use update datacenter to re-name the datacenter or update its description
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
Partially modify a Data Center
You can use update datacenter to re-name the datacenter or update its description
Locations
List Locations
Retrieve a list of Locations. This list represents where you can provision your virtual data centers
List Locations within a region
Retrieve a list of Locations within a world's region
Retrieve a Location
Retrieves the attributes of a given location
Servers
List Servers
You can retrieve a list of servers within a datacenter
Create a Server
Creates a server within an existing datacenter. You can configure the boot volume and connect the server to an existing LAN.
Retrieve a Server
Returns information about a server such as its configuration, provisioning status, etc.
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
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
Partially modify a Server
You can use update attributes of a server
List Attached Volumes
You can retrieve a list of volumes attached to the server
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.
Retrieve an attached volume
This will retrieve the properties of an attached volume.
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
List attached CD-ROMs
You can retrieve a list of CD-ROMs attached to the server.
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.
Retrieve an attached CD-ROM
You can retrieve a specific CD-ROM attached to the server
Detach a CD-ROM
This will detach a CD-ROM from the server
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.
Start a Server
This will start a server. If the server's public IP was deallocated then a new IP will be assigned
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.
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.
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.
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'
Get the server's jwToken
Returns the server json web token to be used for login operations (ex: accessing the server console)
Get the server remote console link
Returns the link with the jwToken to access the server remote console
Images
List Images
Retrieve a list of images within the datacenter
Retrieve an Image
Retrieves the attributes of a given image.
Modify an Image
You can use update attributes of a resource
Delete an Image
Deletes the specified image. This operation is permitted on private image only.
Partially modify an Image
You can use update attributes of a resource
Volumes
List Volumes
Retrieves a list of Volumes.
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
Retrieve a Volume
Retrieves the attributes of a given Volume
Modify a Volume
You can use update attributes of a Volume
Delete a Volume
Deletes the specified volume. This will result in the volume being removed from your datacenter. Use this with caution.
Partially modify a Volume
You can use update attributes of a volume.
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.
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.
Snapshots
List Snapshots
Retrieve a list of available snapshots.
Retrieve a Snapshot by its uuid.
Retrieves the attributes of a given Snapshot.
Modify a Snapshot
You can use update attributes of a resource.
Delete a Snapshot
Deletes the specified snapshot.
Partially modify a Snapshot
You can use this method to update attributes of a snapshot.
IP Blocks
List IP Blocks
Retrieve a list of all reserved IP Blocks.
Reserve IP Block
This will reserve a new IP Block.
Retrieve an IP Block
Retrieves the attributes of a given IP Block.
Modify IP Block
You can use update attributes of a resource.
Delete IP Block
Removes the specific IP Block.
Partially modify IP Block
You can use update attributes of a resource.
Lans
List Lans
Retrieve a list of LANs within the datacenter.
Create a Lan
Creates a LAN within the datacenter.
Retrieve a Lan
Retrieves the attributes of a given LAN.
Modify a Lan
You can use update attributes of a resource.
Delete a Lan.
Removes the specific LAN.
Partially modify a Lan
You can use update attributes of a resource.
List Lan Members
You can retrieve a list of nics attached to a LAN.
Attach a nic
This will attach a pre-existing nic to a LAN.
Retrieve a nic attached to lan
This will retrieve the properties of an attached network interface.
Network Interfaces
List Network Interfaces
Retrieves a list of network interfaces.
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.
Retrieve a Network Interface
Retrieves the attributes of a given network interface.
Modify a Network Interface
You can use update attributes of a network interface.
Delete a Network Interface
Deletes the specified network interface.
Partially Modify a Network Interface
You can use update attributes of a network interface.
Firewall Rules
List Firewall Rules
Retrieves a list of firewall rules associated with a particular network interface.
Create a Firewall Rule
This will add a Firewall Rule to the network interface.
Retrieve a Firewall Rule
Retrieves the attributes of a given firewall rule.
Modify a Firewall Rule
You can use update attributes of a resource.
Delete a Firewall Rule
Removes the specified firewall rule.
Partially Modify a Firewall Rule
You can use update attributes of a resource.
Flow Logs
List Flow Logs
Retrieves a list of Flow Logs associated with a particular network interface.
Create a Flow Log
This will add a Flow Log to the network interface.
Retrieve a Flow Log
Retrieves the attributes of a given Flow Log.
Modify a Flow Log
This will update a Flow Log record.
Partially update a Flow Log
This will partially update a Flow Log record.
Delete a Flow Log
Removes the specified Flow Log.
Load Balancers
List Load Balancers
Retrieve a list of Load Balancers within the datacenter.
Create a Load Balancer
Creates a Loadbalancer within the datacenter.
Retrieve a loadbalancer
Retrieves the attributes of a given load balancer.
Modify a Load Balancer
You can use update attributes of a resource.
Delete a Loadbalancer.
Removes the specified load balancer.
Partially modify a Loadbalancer
You can use update attributes of a resource.
List Load Balancer balaced NICs
You can retrieve a list of nics attached to a load balancer.
Attach a nic to Load Balancer
This will attach a pre-existing nic to a load balancer.
Retrieve a network interface attached to Load Balancer
This will retrieve the properties of an attached network interface.
Detach a nic from loadbalancer
This will remove a network interface from load balancer.
NAT Gateways
List NAT Gateways
Retrieve a list of NAT Gateways within the datacenter.
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
Retrieve a NAT gateway
Retrieves the attributes of a given NAT gateway.
Update a NAT gateway
Update the attributes of a given NAT gateway
Partially update a NAT gateway
Partially update the attributes of a given NAT gateway
Remove a NAT gateway
Removes the specified NAT gateway.
List NAT Gateways Rules
Retrieve a list of rules of a NAT Gateway within the datacenter.
Create a NAT Gateway Rule
Creates a rule within the NAT Gateway of a datacenter.
Retrieve a NAT Gateway Rule
Retrieves the attributes of a given NAT gateway rule.
Modify a rule of the NAT gateway
You can use to update a rule of the NAT gateway.
Partially modify a rule of the NAT gateway
You can use to partially update a rule of a NAT gateway.
Remove rule from NAT Gateway
This will remove a rule from the NAT gateway.
List NAT Gateway Flow Logs
You can retrieve a list of Flow Logs of the NAT Gateway.
Add a NAT Gateways Flow Log
This will add a new Flow Log to the NAT Gateway.
Retrieve a Flow Log of the NAT Gateway
This will return a Flow Log of the NAT Gateway.
Modify a Flow Log of the NAT Gateway
You can use to update a Flow Log of the NAT Gateway.
Partially modify a Flow Log of the NAT Gateway
You can use to partially update a Flow Log of a NAT Gateway.
Remove Flow Log from NAT Gateway
This will remove a flow log from the NAT gateway.
Network Load Balancers
List Network Load Balancers
Retrieve a list of Network Load Balancers within the datacenter.
Create an Network Load Balancer
Creates an Network Load Balancer within the datacenter.
Retrieve an Network Load Balancer
Retrieves the attributes of a given Network Load Balancer.
Update an Network Load Balancer
Update the attributes of a given Network Load Balancer
Partially update an Network Load Balancer
Partially update the attributes of a given Network Load Balancer
Remove an Network Load Balancer
Removes the specified Network Load Balancer.
List Network Load Balancer Flow Logs
You can retrieve a list of Flow Logs of the Network Load Balancer.
Add a Network Load Balancer Flow Log
This will add a new Flow Log to the Network Load Balancer.
Retrieve a Flow Log of the Network Load Balancer
This will return a Flow Log of the Network Load Balancer.
Modify a Flow Log of the Network Load Balancer
You can use to update a Flow Log of the Network Load Balancer.
Partially modify a Flow Log of the Network Load Balancer
You can use to partially update a Flow Log of a Network Load Balancer.
Remove Flow Log from Network Load Balancer
This will remove a flow log from the network load balancer.
List Network Load Balancer Forwarding Rules
You can retrieve a list of forwarding rules of the Network Load Balancer.
Add a Network Load Balancer Forwarding Rule
This will add a new forwarding rule to the Network Load Balancer.
Retrieve a Forwarding Rule of the Network Load Balancer
This will a forwarding rule of the Network Load Balancer.
Modify a forwarding rule of the Network Load Balancer
You can use to update a forwarding rule of the Network Load Balancer.
Partially modify a forwarding rule of the Network Load Balancer
You can use to partially update a forwarding rule of a Network Load Balancer.
Remove Forwarding Rule from Network Load Balancer
This will remove a forwarding rule from the Network Load Balancer.
Application Load Balancers
List Application Load Balancers
Retrieve a list of Application Load Balancers within the datacenter.
Create an Application Load Balancer
Creates an Application Load Balancer within the datacenter.
Retrieve an Application Load Balancer
Retrieves the attributes of a given Application Load Balancer.
Update an Application Load Balancer
Update the attributes of a given Application Load Balancer
Partially update an Application Load Balancer
Partially update the attributes of a given Application Load Balancer
Remove an Application Load Balancer
Removes the specified Application Load Balancer.
List Application Load Balancer Forwarding Rules
You can retrieve a list of forwarding rules of the Application Load Balancer.
Add an Application Load Balancer Forwarding Rule
This will add a new forwarding rule to the Application Load Balancer.
Retrieve a Forwarding Rule of the Application Load Balancer
This will a forwarding rule of the Application Load Balancer.
Modify a forwarding rule of the Application Load Balancer
You can use to update a forwarding rule of the Application Load Balancer.
Partially modify a forwarding rule of the Application Load Balancer
You can use to partially update a forwarding rule of an Application Load Balancer.
Remove Forwarding Rule from Application Load Balancer
This will remove a forwarding rule from the Application Load Balancer.
List Application Load Balancer Flow Logs
You can retrieve a list of Flow Logs of the Application Load Balancer.
Add a Application Load Balancer Flow Log
This will add a new Flow Log to the Application Load Balancer.
Retrieve a Flow Log of the Application Load Balancer
This will return a Flow Log of the Application Load Balancer.
Modify a Flow Log of the Application Load Balancer
You can use to update a Flow Log of the Application Load Balancer.
Partially modify a Flow Log of the Application Load Balancer
You can use to partially update a Flow Log of a Application Load Balancer.
Remove Flow Log from Application Load Balancer
This will remove a flow log from the application load balancer.
Target Groups
List Target Groups
You can retrieve a list of all Target Groups.
Add a Target Group
This will add a new Target Group.
Retrieve a Target Group
Retrieves the attributes of a given Target Group.
Update a Target Group
Update the attributes of a given Target Group
Partially update a Target Group
Partially update the attributes of a given Target Group
Remove a Target Group
Removes the specified Target Group.
Requests
Retrieve a Request
Retrieves the attributes of a given request.
List Requests
Retrieve a list of API requests.
Retrieve Request Status
Retrieves the status of a given request.
Contract Resources
Retrieve a Contract
Retrieves the attributes of user's contract. In this version, the resource became a collection.
User Management
List all Users
You can retrieve a complete list of users under your account
Create a user
You can use this POST method to create a user
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.
Modify a user
You can use update attributes of a User
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.
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.
List All Groups.
You can retrieve a complete list of all groups that you have access to
Create a Group
You can use this POST method to create a group
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.
Modify a group
You can use this method to update properties of the group.
List Group Members
You can retrieve a list of users who are members of the group
Add a user to a group
This will attach a pre-existing user to a group.
Remove a user from a group
This will remove a user from a group.
Retrieve a group share
This will retrieve the properties of a group share.
Add a resource to a group
This will add a resource to the group.
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
Remove a resource from a group
This will remove a resource from a group
List Group Shares
You can retrieve a list of all resources along with their permissions of the group
List All Resources.
You can retrieve a complete list of all resources that you have access to.
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.
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.
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.
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
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
Modify a S3 key having the given key id
You can enable or disable a given S3 key.
Delete an S3 Key
Delete an S3 key.
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.
Backup Units
List Backup Units
You can retrieve a complete list of backup Units that you have access to.
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
Returns the specified Backup Unit
You can retrieve the details of an specific backup unit.
Modify a Backup Unit
You can use update a Backup Unit properties.
Partially modify a Backup Unit
You can use update a Backup Unit properties.
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
Returns a single signon URL for the specified Backup Unit
Returns a single signon URL for the specified Backup Unit.
Kubernetes
List Kubernetes Clusters
You can retrieve a list of all kubernetes clusters associated with a contract
Create Kubernetes Cluster
This will create a new Kubernetes Cluster.
Retrieve Kubernetes Cluster
This will retrieve a single Kubernetes Cluster.
Modify Kubernetes Cluster
This will modify the Kubernetes Cluster.
Delete Kubernetes Cluster
This will remove a Kubernetes Cluster.
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
List Kubernetes Node Pools
You can retrieve a list of all kubernetes node pools part of kubernetes cluster
Create a Kubernetes Node Pool
This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.
Retrieve Kubernetes Node Pool
You can retrieve a single Kubernetes Node Pool.
Modify Kubernetes Node Pool
This will modify the Kubernetes Node Pool.
Delete Kubernetes Node Pool
This will remove a Kubernetes Node Pool.
Retrieve Kubernetes nodes.
You can retrieve all nodes of Kubernetes Node Pool.
Retrieve Kubernetes node
You can retrieve a single Kubernetes Node.
Delete Kubernetes node
This will remove a Kubernetes node.
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.
Retrieve available Kubernetes versions
You can retrieve a list of available kubernetes versions
Retrieve the current default kubernetes version for clusters and nodepools.
You can retrieve the current default kubernetes version for clusters and nodepools.
Private Cross Connects
List Private Cross-Connects
You can retrieve a complete list of private cross-connects provisioned under your account
Create a Private Cross-Connect
You can use this POST method to create a private cross-connect.
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.
Delete a Private Cross-Connect
Delete a private cross-connect if no datacenters are joined to the given PCC
Partially Modify a Private Cross-Connect
You can use update private cross-connect to re-name or update its description
Labels
List Labels
You can retrieve a complete list of labels that you have access to.
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:
List all Data Center Labels
You can retrieve a list of all labels associated with a data center.
Add a Label to Data Center
This will add a label to the data center.
Retrieve a Label of Data Center
This will retrieve the properties of a associated label to a data center.
Modify a Label of Data Center
This will modify the value of the label on a data center.
Delete a Label from Data Center
This will remove a label from the data center.
List all Server Labels
You can retrieve a list of all labels associated with a server.
Add a Label to Server
This will add a label to the server.
Retrieve a Label of Server
This will retrieve the properties of a associated label to a server.
Modify a Label of Server
This will modify the value of the label on a server.
Delete a Label from Server
This will remove a label from the server.
List all Volume Labels
You can retrieve a list of all labels associated with a volume.
Add a Label to Volume
This will add a label to the volume.
Retrieve a Label of Volume
This will retrieve the properties of a associated label to a volume.
Modify a Label of Volume
This will modify the value of the label on a volume.
Delete a Label from Volume
This will remove a label from the volume.
List all Snapshot Labels
You can retrieve a list of all labels associated with a snapshot.
Add a Label to Snapshot
This will add a label to the snapshot.
Retrieve a Label of Snapshot
This will retrieve the properties of a associated label to a snapshot.
Modify a Label of Snapshot
This will modify the value of the label on a snapshot.
Delete a Label from Snapshot
This will remove a label from the snapshot.
List all Ip Block Labels
You can retrieve a list of all labels associated with a IP Block.
Add a Label to IP Block
This will add a label to the Ip Block.
Retrieve a Label of IP Block
This will retrieve the properties of a associated label to a Ip Block.
Modify a Label of IP Block
This will modify the value of the label on a Ip Block.
Delete a Label from IP Block
This will remove a label from the Ip Block.
Templates
List Templates
Retrieve a list of available templates. Templates can be used on specific server types only (CUBE at the moment)
Retrieve an available template
Retrieves the attributes of a given template.