Public API Reference

This section lists all methods constituting the POA 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 POA version 2.3 or later, if not otherwise stated explicitly. New methods and new optional parameters for existing methods introduced in subsequent releases of POA are marked with the version of POA where they were introduced for the first time.

For the sake of convenience, the following table groups all methods from POA 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.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.apache.updateLimits

2.9

pem.apache.turnWebStatProcessingOn

2.9 hotfix01

pem.apache.turnWebStatProcessingOff

2.9 hotfix01

pem.APS.getApplicationInstance

2.9 hotfix01

pem.APS.getApplicationInstanceSettings

2.9 hotfix01

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.installApplicationInstanceLicense

2.9 hotfix04

pem.APS.removeApplicationInstanceLicense

2.9 hotfix04

pem.bindServicesToDomain

2.8

pem.getRequiredNameServers (internal)

2.8

pem.removeDomainRequest

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

pem.batchRequest

2.3

pem.bindIPPool

2.6.3

pem.brandDomain

2.6

pem.changeUserPassword

2.6.5

pem.checkPassword

2.4

pem.cqmail.addMailbox

2.4

pem.cqmail.addMailname

2.6.4

pem.cqmail.delMailname

2.6.4

pem.cqmail.editMailname

2.6.4

pem.cqmail.addMailForwarding

2.5

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

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.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.enableUnifiedMessaging

5.0

pem.exchange.disableUnifiedMessaging

5.0

pem.getAccountDomains

5.0

pem.getAccountRoles

5.0

pem.getAccountMemberRoles

5.0

pem.getCustomerSubscriptionsResources

2.9 hotfix01

pem.getDomainsForBrandCreation

5.0

pem.getDomainNameServers

5.0

pem.global_relay.createArchive

2.8 hotfix02

pem.global_relay.disableArchive

2.8 hotfix02

pem.global_relay.disableArchiving

2.8 hotfix02

pem.global_relay.enableArchive

2.8 hotfix02

pem.global_relay.enableArchiving

2.8 hotfix02

pem.global_relay.getArchive

2.8 hotfix02

pem.global_relay.getArchiveRecipients

2.8 hotfix02

pem.global_relay.getArchiveRecipientsCandidates

2.8 hotfix02

pem.global_relay.retryArchiveOperation

2.8 hotfix02

pem.exchange.modifyMailbox

2.6.5

pem.exchange.moveMailboxes

2.8

pem.exchange.addMailboxWithTemplate

2.9

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.addBlackBerry

2.8 hotfix02

pem.exchange.addGoodlink

2.8 hotfix02

pem.exchange.addDistributionList

2.8 hotfix02

pem.exchange.addDistributionListMembers

2.8 hotfix02

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.removeContact

2.8 hotfix02

pem.exchange.getSMTPFilters

2.8 hotfix02

pem.exchange.getOutlookLicense

2.9

pem.exchange.enableOutlookLicense

2.9

pem.exchange.disableOutlookLicense

2.9

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.grantMailboxPermissions

2.9 hotfix03

pem.exchange.revokeMailboxPermissions

2.9 hotfix03

pem.getVendorCustomers

2.9 hotfix03

pem.getCustomerSubscriptions

2.9 hotfix03

pem.getAccountInfo

2.4

pem.getAccountMemberByLogin

2.7

pem.getAccountSubscriptions

2.4

pem.getDomainByName

2.8

pem.getDomainSubscription

2.4

pem.getDomainList

2.5

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.iis.addDomainMapping

2.6.5

pem.iis.addSystemMapping

2.6.5

pem.iis.applySystemMappingsToHosts

2.6.5

pem.iis.bulkAddDomainMapping

2.6.5

pem.iis.deleteSystemMapping

2.6.5

pem.iis.getDomainEngines

2.6.5

pem.iis.getDomainMapping

2.6.5

pem.iis.getDomainMappings

2.6.5

pem.iis.getSystemEngines

2.6.5

pem.iis.getSystemMapping

2.6.5

pem.iis.getSystemMappings

2.6.5

pem.iis.getWebspaceFeaturesInfo

2.8

pem.iis.resetDomainMapping

2.6.5

pem.iis.setDomainMappingEnabled

2.6.5

pem.iis.getSubscriptionWebsites

2.8

pem.iis.getSubscriptionSharePointSites

2.8

pem.iis.getWebspacesInfo

2.8

pem.iis.setWebspaceFeaturesInfo

2.8

pem.iis.updateDomainMapping

2.6.5

pem.iis.updateLimits

2.9

pem.iis.updatePHPExtensionsList

2.9

pem.iis.updateSystemEngine

2.6.5

pem.iis.updateSystemMapping

2.6.5

pem.iis.grantAuthorizedWebAccess

2.9

pem.iis.revokeAuthorizedWebAccess

2.9

pem.iis.getAuthorizedWebAccessDomainsForUser

2.9

pem.iis.getAuthorizedWebAccessUsersForDomain

2.9

pem.iis.getFTPAccessStatusForUser

2.9 hotfix01

pem.iis.getFTPAccessStatusesForDomain

2.9 hotfix01

pem.iis.grantFTPAccessToWebsite

2.9 hotfix01

pem.iis.revokeFTPAccessFromWebsite

2.9 hotfix01

pem.importCertificate

2.3

pem.installPleskLicense

2.6.5

pem.migrateSubscription (deprecated)

2.5

pem.modifyUser

2.6.5

pem.mscrm.createOrg

2.8

pem.mscrm.createUser

2.8

pem.mscrm.disableOrg

2.8

pem.mscrm.enableOrg

2.8

pem.mscrm.getBusinessUnits

2.8

pem.mscrm.getCurrencies

2.8

pem.mscrm.getOrgBySubscription

2.8

pem.mscrm.getOrgInfo

2.8

pem.mscrm.getOrgList

2.8

pem.mscrm.getOrgUsers

2.8

pem.mscrm.getSecurityRoles

2.8

pem.mscrm.getUserInfo

2.8

pem.mscrm.modifySecurityRoles

2.8

pem.mscrm.moveUser

2.8

pem.mscrm.removeOrg

2.8

pem.mscrm.removeUser

2.8

pem.mscrm.setExchangeDeliverySettings

2.8

pem.mscrm.setExternalDeliverySettings

2.8

pem.mscrm.setNoneDeliverySettings

2.8

pem.mscrm.setOrgDisplayName

2.8

pem.mscrm.setOutlookDeliverySettings

2.8

pem.mssql.setQuota

2.6.5

pem.mysql.applyMySQLActivationParams

2.9

pem.orderSubscription (deprecated)

2.3

pem.ocs.getPhoneNumberList

5.0

pem.packaging.native_repository.createRepository

2.6

pem.packaging.native_repository.getRepository

2.6

pem.packaging.native_repository.reindex

2.6

pem.packaging.native_repository.removeRepository

2.6

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.getExternalSystemList

2.9

pem.unregisterExternalSystem

2.9

pem.registerSharedNode

5.0

pem.removeAccount

2.3.01

pem.removeAccountMember

2.3.01

pem.removeDNSHosting

2.6.4

pem.removeDomain

2.3

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.setMemberInfo

2.6.2

pem.setMemberPassword

2.6.2

pem.setResourceTypeLimit

2.3

pem.setResourceTypeLimits

2.6.1

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.sharepoint.createSharePointSite

2.8 hotfix02

pem.sharepoint.deleteSharePointSite

2.8 hotfix02

pem.sharepoint.getAvailableSharePointSiteTemplates

2.8 hotfix02

pem.sharepoint.addSharePointUser

2.8 hotfix02

pem.sharepoint.removeSharePointUser

2.8 hotfix02

pem.sharepoint.createSharePointSiteInSharedApplication

5.0

pem.spam_assassin.addItems

5.0

pem.spam_assassin.deleteItems

5.0

pem.spam_assassin.getItems

5.0

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

txn.Begin

2.6.3

txn.Commit

2.6.3

txn.Rollback

2.6.3