Cloud Server
API
User authentication
APIs are protected by a username and password and require authorization for each operation performed. For more details, please see the articles on
how to get login details and
connecting to the API.
Features available using API
- Get data center configurations (GetDatacenterConfigurations)
- Get list of hypervisors and templates associated with each hypervisor (GetHypervisors)
- Get list of templates and configurable resources for them (GetHypervisors)
- Get list of VirtualDataCenter class objects (GetVirtualDatacenter)
- See details of costs for each component of a virtual data center (GetVirtualDatacenterCost)
- Check credit for specific account being authenticated (GetCredit)
- Get list of job objects (GetJobs)
- Get list of active jobs for a specific server (GetServerDetails)
- Get list of log messages generated in a specified period (GetLogs)
- Get list of user notifications such as licenses purchased, promotions, news, etc. (GetNews)
- Mark News as read to avoid it being resent to the user (SetReadNews)
- Create a virtual server specifying the features of the resources (SetEnqueueServerCreation)
- Get preconfigured packages (GetPreconfiguredPackages)
- Queue a virtual server startup job (SetEnqueueServerStart)
- Switch off server as if switching off power (SetEnqueueServerPowerOff)
- Switch off server using commands from operating system (SetEnqueueServerStop)
- Queue a virtual server deletion job (SetEnqueueServerDeletion)
- Reserve first free public IP address for account specified (SetPurchaseIpAddress)
- Remove specified IP address, if linked to the account used to call the method (SetRemoveIpAddress)
- Get list of IP Address class objects representing IP addresses purchased (GetPurchasedIpAddresses)
- Buy a denominated VLan (SetPurchaseVLan)
- Remove specified VLan (SetRemoveVLan)
- Restore VLan configuration (GetPurchasedVLans)
- Get hourly tariffs for specified account being authenticated (GetPriceList)
- See details of hourly and monthly costs and make projections for individual components of virtual data center (GetVirtualDataCenterCost)
- Edit resources of virtual server, specifying features of resources that have been changed (SetEnqueueServerUpdate)
- Queue a virtual disk management job (SetEnqueueVirtualDiskManage)
- Edit the displayed name for a server (SetRenameServer)
- Associate one or more IP Adresses reserved for the account provided during authentication to a network adapter (SetEnqueueAssociateIpAddress)
- Remove one or more IP Adresses reserved for the account provided during authentication from a network adapter (SetEnqueueDeassociateIpAddress)
- Associate a network adapter to a virtual switch (SetEnqueueAssociateVLan)
- Associate a virtual switch to our server (SetEnqueueAssociateVLan)
- Remove a network adapter associated to a virtual switch (SetEnqueueDeassociateVLan)
- Create, restore or delete a snapshot of virtual server disks (SetEnqueueServerSnapshot)
- Add, edit or delete notes for a specific virtual server (SetChangeNoteServer)
- Queue a virtual server archive job (SetEnqueueServerArchiviation)
- Queue an archived virtual server recovery job (SetEnqueueServerRestore)
- Associate IP addresses to a network adapter (SetEnqueueAssociateIpAddress)
- Remove IP addresses associated to a network adapter (SetEnqueueDeassociateIpAddress)
- Create an FTP account (SetEnqueueCreateFTPAccount)
- Resize the user's FTP space (SetEnqueueResizeFTPAccount)
- Get login details (GetPurchasedFTP)
- Get list of CustomVirtualDisk class objects representing virtual disks imported in the FTP area (GetCustomVirtualDisks)
- Export a virtual disk (SetEnqueueVirtualDiskExport)
- Mount ISO image on a virtual server (SetEnqueueMountDvdIso)
- Remove ISO image from a virtual server (SetEnqueueUnmountDvdIso)
- Format a virtual server (SetEnqueueReinitializeServer)
- Purchase a license specifying the mother license and any Addon licenses and their quantities (SetEnqueuePurchasePleskLicense)
- Remove a license, if associated with the account being used to call the method (SetRemoveLicense)
- Get detailed information on licenses purchased by the user(GetPurchasedLicenses)
- Get list of available licenses (GetAvailableLicenses)
- See scheduled tasks (GetScheduledOperations)
- Read occurrences performed from scheduled tasks (GetScheduleOccurrences)
- Add scheduled task (SetAddServerScheduledOperation)
- Add recurring scheduled task (SetAddServerScheduledOperation)
- Edit recurring scheduled task (SetUpdateServerScheduledOperation)
- Suspend recurring scheduled task (SetUpdateServerScheduledOperation)
- Remove scheduled task (SetRemoveServerScheduledOperation)
- Display all storage purchased by an account (GetSharedStorages)
- Purchase network storage (SetEnqueuePurchaseSharedStorage)
- Resize storage (SetEnqueueModifySharedStorage)
- Remove network storage (SetEnqueueRemoveSharedStorage)
- Edit network storage name (SetRenameSharedStorage)
- Get list of load balancers (GetLoadBalancers)
- Create load balancer (SetEnqueueLoadBalancerCreation)
- Run a load balancer (SetEnqueueLoadBalancerStart)
- Edit load balancer name and "health check notification agreement" parameter (SetModifyLoadBalancer)
- Switch off load balancer (SetEnqueueLoadBalancerPowerOff)
- Delete load balancer (SetEnqueueLoadBalancerDeletion)
- Get balancer load statistics (GetLoadBalancerLoads)
- Get list of statistics of load balancer rule (GetLoadBalancerRuleStatistics)
- Add load balancer rule (SetAddLoadBalancerRule)
- Remove load balancer rule (SetRemoveLoadBalancerRule)
- Add IP address to load balancer (SetEnqueueLoadBalancerAddInstances)
- Remove addresses from load balancer (SetEnqueueLoadBalancerRemoveInstances)
- Get list of notifications to be sent for load balancer (GetLoadBalancerNotifications)
- Add contact to load balancer (SetAddLoadBalancerContacts)
- Remove contact from load balancer (SetRemoveLoadBalancerContacts)
- Get list of active custom templates created by user (GetAvailablePersonalTemplates)
- Create new custom template from primary disk of an active Cloud Server (SetEnqueuePersonalTemplateCreation)
- Update attributes of personal template created (UpdatePersonalTemplate)
- Remove personal template created by user (SetRemovePersonalTemplate)
- Get list of support requests submitted by user in a specific time period (GetUserAssistanceRequests)
- Submit support request (SetInsertAssistanceRequest)
- Edit support request (SetUpdateAssistanceRequest)
- Submit previous request from 'draft' status to support team (SetSendAssistanceRequest)
- Get all details of support request (GetAssistanceRequestDetails)
- Accept or decline a quotation proposed by support team (SetAssistanceQuotationAcceptance)
- Get list of Private Clouds purchased (GetPurchasedPrivateClouds)
- See attributes of a Private Cloud (GetPrivateCloudResourcesTypes)
- Purchase a Private Cloud (setEnqueuePurchasePrivateCloud)
- Edit name, description, telephone number and email of a Private Cloud (SetModifyPrivateCloud)
- Edit quantity of resources of a Private Cloud (SetEnqueueModifyPrivateCloudResources)
- Delete a Private Cloud (SetEnqueuePrivateCloudDeletion)
- Activate a Private Cloud (SetEnqueuePrivateCloudActivation)
- Return a list of languages that can be used to submit support requests (GetAssistanceLanguages)
- Get company based on URL parameters (GetCompanyByUrl)
- Return details of template available for individual (GetHypervisorDetails)
- Return the different types of Hypervisor (GetHypervisorTypes)
- Return a list of Iso images available (GetIsos)
- Get network adapter configuration for specified server (GetNetworkAdapterConfiguration)
- Get details of purchased Private Cloud (GetPurchasedPrivateCloudDetails)
- Return list of scheduler types (GetSchedulerDataTypes)
- Get logs of scheduled tasks for a given server (GetServerSchedulesLogs)
- Get list of servers per specified user (GetServers)
- Show resource usage statistics for a given server (GetSystemStatusHistory)
- Return list of template attributes (GetTemplateCategories)
- Return detail of a given template (GetTemplateDetails)
- Produce token and associate it to user making the call (GetUserAuthenticationToken)
- Return user data (GetUserInfo)
- Add a graphic display of the user's virtual data center (GetVDCGraph)
- Set a graphic display of the user's virtual data center (SetAddVDCGraph)
- Add IQN to Network Storage (SetEnqueueAddIQNSharedStorage)
- Remove IQN from Network Storage (SetEnqueueRemoveIQNSharedStorage)
- Reset the virtual server specified (SetEnqueueServerReset)
- Reboot the virtual server specified (SetEnqueueServerRestart)
- Assign a new name to the specified account being authenticated (SetRenameVLan)
- Allow update of personal template attributes (SetUpdatePersonalTemplate)
- Update graphic display of virtual data center (SetUpdateVDCGraph)
API documentation