Public API Reference

This section lists all methods constituting the Operations Public API along with comprehensive explanation of their input and output parameters. The list is sorted in alphabetical order for better navigation.

Descriptions of all methods follow the same way: first, a short explanation is given of what the method does, and then lists of its input and output parameters are provided in tabular form. If the method participates in complex scenario involving other methods, a link to the corresponding diagram, explaining this scenario, is given.

Types of all arguments are given in terms of XML-RPC specification.

All methods described in this document are supported by Operations version 2.3 or later, if not otherwise stated explicitly. New methods and new optional parameters for existing methods introduced in subsequent releases of Operations are marked with the version of Operations where they were introduced for the first time.

For the sake of convenience, the following table groups all methods from Operations Public API by releases where they were introduced for the first time.

Method Name

Effective since version

pem.activateST

2.6.4

pem.activateSubscription

2.3.01

pem.ad.binding.addUserBinding

5.0.1_KB9347

pem.ad.binding.removeUserBinding

5.0.1_KB9347

pem.ad.binding.getUserInfo

5.0.1_KB9347

pem.addAccount

2.3

pem.addAccountMember

2.3

pem.addDNSHosting

2.6.4

pem.addDomain

2.3

pem.addDomainRequest

2.8

pem.addDomainToAccount

2.8

pem.APS.getApplicationInstance

2.9 hotfix01

pem.APS.getApplicationInstanceSettings

2.9 hotfix01

pem.APS.getApplicationInstances

5.5

pem.APS.getApplicationInstanceToken

5.5

pem.APS.getAccountToken

5.5

pem.APS.getUserToken

5.5

pem.APS.getApplicationSettings

2.9 hotfix01

pem.APS.getPackage

2.9 hotfix01

pem.APS.getProvisioningSettings

2.9 hotfix01

pem.APS.getSubscriptionApplicationInstances

2.9 hotfix01

pem.APS.importPackage

2.9 hotfix01

pem.APS.provideApplicationInstance

2.9 hotfix01

pem.APS.removeApplication

2.9 hotfix01

pem.APS.setApplicationInstanceSettings

2.9 hotfix01

pem.APS.unimportPackage

2.9 hotfix01

pem.APS.unprovideApplicationInstance

2.9 hotfix01

pem.APS.upgradeApplicationInstance

2.9 hotfix01

pem.APS.getApplicationInstanceLicenseActivationData

2.9 hotfix04

pem.APS.getApplicationLicenseInfo

2.9 hotfix04

pem.APS.getServiceInstances

5.4.4

pem.APS.setServiceInstanceResourceType

5.4.4

pem.APS.provideServiceInstance

5.4.4

pem.APS.unprovideServiceInstance

5.4.4

pem.APS.setServiceInstanceSettings

5.4.4

pem.APS.getApplicationInstanceServiceResourceTypes

5.4.4

pem.APS.getApplications

5.4.4

pem.APS.getUserServiceInstances

5.4.4

pem.APS.installApplicationInstanceLicense

2.9 hotfix04

pem.APS.removeApplicationInstanceLicense

2.9 hotfix04

pem.APS.registerUserInApplicationInstance

5.3

pem.bindServicesToDomain

2.8

pem.getRequiredNameServers (internal)

2.8

pem.syncNameServers (internal)

2.8

pem.unbindServicesFromDomain

2.8

pem.addProvisioningAttributes

2.6.3

pem.addPTRRecord

2.6.5

pem.addResourceType

2.6.3

pem.addResourceTypeToServiceTemplate

2.6.5

pem.addServiceTemplate

2.6.3

pem.addSubdomain

2.3

pem.addSubscription

2.3

pem.addUser

2.6.5

pem.assignIPPool

2.6.5

pem.assignRolesToMember

5.0

pem.attachIPPool

2.6.3 (obsoleted from 5.2)

pem.batchRequest

2.3

pem.bindIPPool

2.6.3

pem.brandDomain

2.6

pem.changeAccountOwner

6.0

pem.changeUserPassword

2.6.5

pem.checkMoveSubscriptions

6.0

pem.checkServiceTemplatesForProvisioning

6.0

pem.checkPassword

2.4

pem.cqmail.addMailbox

2.4

pem.cqmail.delMailname

2.6.4

pem.cqmail.editMailname

2.6.4

pem.cqmail.addMailForwarding

2.5

pem.cqmail.editEmailAddresses

5.2

pem.cloneServiceTemplate

5.0

pem.createDatabase

2.3

pem.createDatabaseUser

2.3

pem.createDNSRecord

2.6.1

pem.createIPPool

2.6.3

pem.deactivateST

2.6.4

pem.deleteDNSRecord

2.6.1

pem.disableDNSRecord

2.8 hotfix03

pem.detachIPPool

2.6.3 (obsoleted from 5.2)

pem.disableAccount

2.3

pem.disableAccountMember

2.8 hotfix02

pem.disableDomain

2.3

pem.enableDNSRecord

2.8 hotfix03

pem.disableSubscription

2.3

pem.disableUser

2.6.5

pem.enableAccount

2.3

pem.enableAccountMember

2.8 hotfix02

pem.enableAccountWideServiceUsers

6.0

pem.enableDomain

2.3

pem.enableSubscription

2.3

pem.enableUser

2.6.5

pem.exchange.addEmailAddresses

2.6.5

pem.exchange.addMailbox

2.6.5

pem.exchange.changePrimaryEmailAddress

2.6.5

pem.exchange.disableForwarding

2.6.5

pem.exchange.enableForwarding

2.6.5

pem.exchange.getEmailAddresses

2.6.5

pem.exchange.getEmailDomains

2.7

pem.exchange.getMailboxByEmailAddress

2.6.5

pem.exchange.getMailboxes

2.6.5

pem.exchange.getMailboxInfo

2.6.5

pem.exchange.getMailboxStores

2.8

pem.exchange.getUserMailbox

2.6.5

pem.exchange.grantPublicFolderRoles

5.0

pem.exchange.revokePublicFolderRoles

5.0

pem.exchange.listPublicFolderRoles

5.0

pem.exchange.enableSPLAFeature

5.5

pem.exchange.disableSPLAFeature

5.5

pem.findHost

5.2.1

pem.getAccountDomains

5.0

pem.getAccountRoles

5.0

pem.getAccountMemberRoles

5.0

pem.getAvailableSkins

5.2

pem.getBrandInfo

5.2

pem.getCustomerSubscriptionsResources

2.9 hotfix01

pem.getDomainsForBrandCreation

5.0

pem.importBrandCertificate

7.0

pem.getDomainNameServers

5.0

pem.getHost

5.2.1

pem.getMemberSubscriptionRestrictions

5.4.7

pem.getResourceTypesByClass

5.2.1

pem.getServiceTemplateList

5.2

pem.exchange.modifyMailbox

2.6.5

pem.exchange.moveMailboxes

2.8

pem.exchange.addMailboxWithTemplate

2.9

pem.exchange.assignMasterAccount

5.0.1_KB8923

pem.exchange.changeMailboxTemplate

2.9

pem.exchange.getMailboxTemplates

2.9

pem.exchange.forceMailboxTemplatesUsing

2.9

pem.exchange.removeEmailAddresses

2.6.5

pem.exchange.removeMailbox

2.6.5

pem.exchange.addDistributionList

2.8 hotfix02

pem.exchange.addDistributionListMembers

2.8 hotfix02

pem.exchange.modifyDistributionList

5.3 hotfix09

pem.exchange.removeDistributionListMembers

2.8 hotfix02

pem.exchange.removeDistributionList

2.8 hotfix02

pem.exchange.addPublicFolder

2.8 hotfix02

pem.exchange.mailEnablePublicFolder

2.8 hotfix02

pem.exchange.mailDisablePublicFolder

2.8 hotfix02

pem.exchange.getRootFolderName

2.8 hotfix02

pem.exchange.removePublicFolder

2.8 hotfix02

pem.exchange.addContact

2.8 hotfix02

pem.exchange.getContact

5.3 hotfix09

pem.exchange.modifyContact

5.3 hotfix09

pem.exchange.removeContact

2.8 hotfix02

pem.exchange.addResourceMailbox

5.3 hotfix09

pem.exchange.getResourceMailboxes

5.3 hotfix09

pem.exchange.modifyResourceMailbox

5.3 hotfix09

pem.exchange.getOutlookLicense

2.9

pem.exchange.enableOutlookLicense

2.9

pem.exchange.disableOutlookLicense

2.9

pem.exchange.getDistributionList

5.5

pem.exchange.getDistributionLists

2.9 hotfix03

pem.exchange.getPublicFolders

2.9 hotfix03

pem.exchange.getContacts

2.9 hotfix03

pem.exchange.getDeliveryPermissions

2.9 hotfix03

pem.exchange.getDeliveryPermissionsCandidates

2.9 hotfix03

pem.exchange.grantDeliveryPermissions

2.9 hotfix03

pem.exchange.revokeDeliveryPermissions

2.9 hotfix03

pem.exchange.getMailboxPermissions

2.9 hotfix03

pem.exchange.getMailboxPermissionsCandidates

2.9 hotfix03

pem.exchange.getMasterAccountInfo

5.0.1_KB8923

pem.exchange.grantMailboxPermissions

2.9 hotfix03

pem.exchange.revokeMailboxPermissions

2.9 hotfix03

pem.exchange.unassignMasterAccount

5.0.1_KB8923

pem.getVendorCustomers

2.9 hotfix03

pem.getCustomerSubscriptions

2.9 hotfix03

pem.getAccountInfo

2.4

pem.getAccountMembers

6.0

pem.getAccountMemberByLogin

2.7

pem.getAccountSubscriptions

2.4

pem.getAccountServiceUsers

6.0

pem.getDomainByName

2.8

pem.getDomainSubscription

2.4

pem.getDomainList

2.5

pem.getDNSRecords

5.4.7

pem.getFTPUser

2.4

pem.getNameServers

2.3

pem.getProvisioningAttributes

2.6.3

pem.getRequestStatus

2.6.2

pem.getResourceUsage

2.3

pem.getResourceUsageForPeriod

2.3

pem.getServiceTemplate

2.6.1

pem.getSubscription

2.6.1

pem.getSubscriptionWebspaces

2.8

pem.getUserByLogin

2.6.5

pem.getUserInfo

2.6.5

pem.getUsers

2.6.5

pem.getWebspacesList

2.4

pem.importCertificate

2.3

pem.installPleskLicense

2.6.5

pem.migrateSubscription (deprecated)

2.5

pem.modifyUser

2.6.5

pem.moveSubscriptions

6.0

pem.mysql.applyMySQLActivationParams

2.9

pem.orderSubscription (deprecated)

2.3

pem.promoteToReseller

2.6.4

pem.provisionSubscription (deprecated)

2.3

pem.ProFTPD.createCustomFTPUser

2.9 hotfix01

pem.ProFTPD.deleteCustomFTPUser

2.9 hotfix01

pem.ProFTPD.getCustomFTPUsersList

2.9 hotfix01

pem.registerExternalSystem

2.9

pem.setExternalSystemConfig

2.9

pem.setMemberSubscriptionRestrictions

5.4.7

pem.getExternalSystemList

2.9

pem.unregisterExternalSystem

2.9

pem.registerSharedNode

5.0

pem.registerWindowsNode

5.2

pem.removeAccount

2.3.01

pem.removeAccountMember

2.3.01

pem.removeDNSHosting

2.6.4

pem.removeDomain

2.3

pem.removeLicense

5.0

pem.removePTRRecord

2.6.5

pem.removeSubscription

2.3

pem.removeUser

2.6.5

pem.resetResourceUsage (internal)

2.3

pem.revokeIPPool

2.6.5

pem.revokeRolesFromMember

5.0

pem.revokePleskLicense

2.6

pem.statistics.getStatisticsReport

5.0

pem.setAccountAuthData

2.3

pem.setAccountInfo

2.3

pem.setDomainRegistrarStatus

2.3

pem.setFTPPassword

2.4

pem.setHostAttributes

2.6.3

pem.setHostReadyToProvide

5.2.1

pem.setMemberInfo

2.6.2

pem.setMemberPassword

2.6.2

pem.setResourceTypeLimit

2.3

pem.setResourceTypeLimits

2.6.1

pem.setRTActParams

7.0

pem.setRTAttributes

2.6.3

pem.setSTActivationParams

2.6.3

pem.setSTRTLimits

2.6.3

pem.setSubscriptionName

2.6.1

pem.setSystemProperty

2.6.3

pem.spam_assassin.addItems

5.0

pem.spam_assassin.deleteItems

5.0

pem.spam_assassin.getItems

5.0

pem.tasks.rescheduleTask

5.4

pem.uploadLicense

5.0

pem.unbindIPPool

2.6.3

pem.unbrandDomain

2.6

pem.unsetHostAttributes

2.6.3

pem.updateAccountAndAccountMember

2.3

pem.upgradeSubscription

2.3

pem.virtuozzo.attachVPS

2.6.5

pem.virtuozzo.importTemplate

2.6.3

pem.virtuozzo.installTemplate

2.6.3

pem.virtuozzo.installTemplates

5.0

pem.virtuozzo.removeTemplates

5.0

pem.virtuozzo.updateEZTemplates

5.0

pem.virtuozzo.registerHWNode

2.8

pem.web_cluster.changeNFS

5.4.10

txn.Begin

2.6.3

txn.Commit

2.6.3

txn.Rollback

2.6.3

pem.bindUserToSubscription

5.5.8