CLOUD API (4.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.
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.
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
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
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.
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
You can use update attributes of a server
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
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.
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'
Contract
Retrieve a Contract
Retrieves the attributes of user's contract.
Data Center
List Data Centers
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
Nic
List Firewall Rules
Retrieves a list of firewall rules associated with a particular NIC
Create a Firewall Rule
This will add a Firewall Rule to the NIC
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 specific Firewall Rule
Partially modify a Firewall Rule
You can use update attributes of a resource
List Nics
Retrieves a list of NICs.
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.
Retrieve a Nic
Retrieves the attributes of a given NIC
Modify a Nic
You can use update attributes of a Nic
Delete a Nic
Deletes the specified NIC.
Partially modify a Nic
You can use update attributes of a Nic
User Management
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 Resource by type.
You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock }. The value of resource type can also be found in the response body when you GET a list of all resources.
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 }. This value of resource type also be found in the response body when you GET a list of all resources.
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.
Image
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
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
Lan
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 nic.
Load Balancer
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 Loadbalancer
Modify a Load Balancer
You can use update attributes of a resource
Delete a Loadbalancer.
Removes the specific Loadbalancer
Partially modify a Loadbalancer
You can use update attributes of a resource
List Load Balancer Members
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 nic attached to Load Balancer
This will retrieve the properties of an attached nic.
Detach a nic from loadbalancer
This will remove a nic from Load Balancer
Location
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
Request
Retrieve Request Status
Retrieves the status of a given request.
Retrieve a Request
Retrieves the attributes of a given request.
List Requests
Retrieve a list of API requests.
/
Snapshot
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.
Volume
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.