Adds a specific resource share to a group and optionally allows the setting of permissions for that resource. As an example, you might use this to grant permissions to use an image or snapshot to a specific group.
Add an existing user to a group.
Associates a NIC to a Load Balancer, enabling the NIC to participate in load-balancing
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Attach a CD-ROM to an existing server.
Attach a pre-existing storage volume to the server.
Create a new virtual data center
* name<~String> - The name of the data center * region<~String> - The physical location where the data center will be created ("de/fkb", "de/fra", or "us/las") * description<~String> - An optional description for the data center, e.g. staging, production. * servers<~Hash> - A collection of servers * volumes<~Hash> - A collection of volumes * loadbalancers<~Hash> - A collection of loadbalancers * lans<~Hash> - A collection of LANs in a data center
Adds a Firewall Rule to the NIC
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Create a new group and set group privileges.
Creates a LAN within a data center
Creates a LAN within a data center
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Creates a load balancer within the data center. Load balancers can be used for public or private IP traffic
See the NIC section for attribute definitions
See the NIC section for attribute definitions
Adds a NIC to the target server
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Creates a server within an existing data center. Additional properties such as specifying a boot volume and connecting the server to an existing LAN can be configured.
Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if ramHotPlug is set to TRUE then a minimum of 1024 MB nust be used
Create a new user under a particular contract.
Creates a volume within the data center. This will NOT attach the volume to a server.
This field may only be set in creation requests. When reading, it always returns null. Password has to contain 8-50 characters. Only these characters are allowed: [abcdefghjkmnpqrstuvxABCDEFGHJKLMNPQRSTUVX23456789]
** Either the image or the licenceType parameters need to be provided.
licenceType is required, but if image is supplied, it will already have a licenceType set.
Creates a snapshot of a volume within the data center. A snapshot can be used to create a new storage volume or to restore a storage volume.
Delete virtual data center
Deletes the specified firewall rule
Delete a single group. Resources that are assigned to the group are NOT deleted, but are no longer accessible to the group members unless the member is a Contract Owner, Admin, or Resource Owner.
Delete an existing image
Deletes the specified IP Block
Delete the specified LAN
Deletes the specified load balancer
Deletes the specified NIC
This will remove a server from a data center. NOTE: This will not automatically remove the storage volume(s) attached to a server. A separate API call is required to perform that action.
Remove a resource share from a specified group.
Delete virtual data center
Blacklists the user, disabling them. The user is not completely purged, therefore if you anticipate needing to create a user with the same name in the future, we suggest renaming the user before you delete it.
Deletes the specified volume
Detach a CD-ROM from the server
Detach the volume from the server. Depending on the volume "HotUnplug" settings, this may result in the server being rebooted.
Get all contract resources
Get all virtual data centers
Retrieves a list of firewall rules associated with a particular NIC
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Retrieve a full list of all groups.
Displays a list of all available images.
Retrieve a list of IP Blocks
Retrieves a list of LANs
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieves a list of NICs associated with the load balancer
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieve a list of load balancers within the data center
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Get all locations
Retrieves a list of NICs
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieves a list of requests
Retrieves a list of all resources and optionally their group associations. Please note that this API call can take a significant amount of time to return when there are a large number of provisioned resources.
Get all servers within a datacenter
Retrieve a full list of all the resources that are shared through this group and lists the permissions granted to the group members for each shared resource.
Retrieve a list of all snapshots
Retrieve a list of all the users that have been created under a contract.
Retrieve a list of all volumes
Retrieve the properties of an attached volume
Retrieve the properties of an attached volume
Get a virtual data center by id
* datacenter_id<~String> - UUID of virtual data center
Retrieves the attributes of a given Firewall Rule
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Retrieves the attributes of a given volume
Retrieves a full list of all the users that are members of a particular group.
Retrieves the attributes of a specific image
Retrieves the attributes of a specific IP Block
Retrieves the attributes of a given LAN
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieves the attributes of a given loadbalanced NIC
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieves the attributes of a given load balancer
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Get all locations
Retrieves the attributes of a given NIC
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Retrieves the attributes of a specific request
Retrieves the status of the request
List all shareable resources of a specific type. Optionally include their association with groups, permissions that a group has for the resource, and users that are members of the group.
Create new virtual server
Retrieves the attributes of a given volume
Retrieves the attributes of a specific snapshot
Retrieve details about a specific user including what groups and resources the user is associated with.
Retrieves the attributes of a given volume
* id<~String> - The resource's unique identifier * type<~String> - The type of the requested resource * href<~String> - URL to the object’s representation (absolute path) * metadata<~Hash> - Hash containing the volume metadata * createdDate<~String> - The date the resource was created * createdBy<~String> - The user who created the resource * etag<~String> - The etag for the resource * lastModifiedDate<~String> - The last time the resource has been modified * lastModifiedBy<~String> - The user who last modified the resource * state<~String> - Volume state * properties<~Hash> - Hash containing the volume properties * name<~String> - The name of the volume. * type<~String> - The volume type, HDD or SSD. * size<~Integer> - The size of the volume in GB. * image<~String> - The image or snapshot ID. * imagePassword<~Boolean> - Indicates if a password is set on the image. * bus<~String> - The bus type of the volume (VIRTIO or IDE). Default: VIRTIO. * licenceType<~String> - Volume licence type. ( WINDOWS, LINUX, OTHER, UNKNOWN) * cpuHotPlug<~Boolean> - This volume is capable of CPU hot plug (no reboot required) * cpuHotUnplug<~Boolean> - This volume is capable of CPU hot unplug (no reboot required) * ramHotPlug<~Boolean> - This volume is capable of memory hot plug (no reboot required) * ramHotUnplug<~Boolean> - This volume is capable of memory hot unplug (no reboot required) * nicHotPlug<~Boolean> - This volume is capable of nic hot plug (no reboot required) * nicHotUnplug<~Boolean> - This volume is capable of nic hot unplug (no reboot required) * discVirtioHotPlug<~Boolean> - This volume is capable of Virt-IO drive hot plug (no reboot required) * discVirtioHotPlug<~Boolean> - This volume is capable of Virt-IO drive hot unplug (no reboot required) * discScsiHotPlug<~Boolean> - This volume is capable of Scsi drive hot plug (no reboot required) * discScsiHotUnplug<~Boolean> - This volume is capable of Scsi drive hot unplug (no reboot required) * deviceNumber<~Integer> - The LUN ID of the storage volume
Get a list of CD-ROMs attached to the server
Get a list of volumes attached to the 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
Associates a NIC to a Load Balancer, enabling the NIC to participate in load-balancing
Remove a user from a group.
Restores a snapshot onto a volume. A snapshot is created as just another image that can be used to create new volumes or to restore an existing volume.
This will start a server. If the server‘s public IP was deallocated, then a new IP will be assigned
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
Update an existing virtual data center
* name<~String> - The new name of the data center * description<~String> - The optional description of the data center
Update a Firewall Rule
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Leave portRangeStart and portRangeEnd value null to allow all ports
Leave portRangeStart and portRangeEnd null to allow all ports
Update a group. Normally a PUT request would require that you pass all the attributes and values. In this implementation, you must supply the name, even if it isn‘t being changed. As a convenience, the other four attributes will default to false. You should explicitly set them to true if you want to have them enabled.
Update an existing image
Update LAN properties
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Update a load balancer
See the NIC section for attribute definitions
Update a virtual NIC
Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address
Value null allows all source IPs
to the respective IP address of the NIC is allowed. Value null allows all target IPs
Value null allows all codes.
Value null allows all types
if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports
Update the attributes of an existing virtual server
Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if ramHotPlug is set to TRUE then a minimum of 1024 MB nust be used
Update a group. Normally a PUT request would require that you pass all the attributes and values. In this implementation, you must supply the name, even if it isn‘t being changed. As a convenience, the other four attributes will default to false. You should explicitly set them to true if you want to have them enabled.
Update an existing snapshot
* name<~String> - The name of the snapshot * description<~String> - The description of the snapshot * cpuHotPlug<~Boolean> - This volume is capable of CPU hot plug (no reboot required) * cpuHotUnplug<~Boolean> - This volume is capable of CPU hot unplug (no reboot required) * ramHotPlug<~Boolean> - This volume is capable of memory hot plug (no reboot required) * ramHotUnplug<~Boolean> - This volume is capable of memory hot unplug (no reboot required) * nicHotPlug<~Boolean> - This volume is capable of NIC hot plug (no reboot required) * nicHotUnplug<~Boolean> - This volume is capable of NIC hot unplug (no reboot required) * discVirtioHotPlug<~Boolean> - This volume is capable of Virt-IO drive hot plug (no reboot required) * discVirtioHotUnplug<~Boolean> - This volume is capable of Virt-IO drive hot unplug (no reboot required) * discScsiHotPlug<~Boolean> - This volume is capable of SCSI drive hot plug (no reboot required) * discScsiHotUnplug<~Boolean> - This volume is capable of SCSI drive hot unplug (no reboot required) * licencetype<~String> - The snapshot's licence type: LINUX, WINDOWS, or UNKNOWN.
Update details about a specific user including their privileges. With this PUT operation, you need to supply values for all the attributes, even if you are only updating some of them.
The password attribute is immutable. It is not allowed in update requests. It is recommended that a new user log into the DCD and change their password.
Update a virtual storage