XML API Guide
  • Introduction
  • About XML API
    • XML API Packets
      • Packet Structure
      • A Sample Packet
      • How to Create Packets
      • Creating Packets from XML Schemas
      • Packets Validation
    • Descriptors Overview
    • GUIDs Overview
    • Creating Client Software
      • Client Application Structure
      • Sending Request Packets
      • Parsing Response Packets
      • Handling Errors
      • Client Code Examples
    • What’s New in This Version
    • Reference
      • Before Using The Reference
        • XSD Representation Conventions
        • Data Types
      • XML Schemas for XML API Operators
      • Managing Add-on Plans
        • Add-on Plan Settings
          • Performance Settings
          • Limits
          • Permissions
          • Hosting Settings
          • PHP Settings
        • Available Filters
        • Creating an Add-on Plan
        • Getting Information on Add-on Plans
        • Configuring Add-on Plan Settings
        • Deleting Add-on Plans
        • Including an App in an Add-On Plan
        • Excluding an App From an Add-On Plan
        • Retrieving Descriptor of Limits
        • Retrieving Descriptor of Permissions
        • Retrieving Descriptor of Hosting Settings
        • Creating a Copy of an Add-On Plan
      • Managing APS Catalog and Applications
        • Defining Available APS Catalogs
        • Importing Application Package to Plesk
        • Downloading Application Package from APS Catalog
        • Getting Download Task Status
        • Retrieving Available Packages
        • Installing Application on Domain or Subdomain
        • Configuring Package Properties
      • Managing Customer Accounts
        • Available Filters
        • Customer Settings
          • General Customer Account Settings
            • Type clientAddGenInfo
            • Type clientGetGenInfo
            • Type clientSetGenInfo
          • Statistics
        • Creating Customer Accounts
        • Getting Information About Customer Accounts
        • Deleting Customer Accounts
        • Setting Customer Account Properties
        • Upgrading Customer Account to Reseller Account
        • Transferring a Customer Account to a New Owner
        • Retrieving the List of Customer’s Domains
      • Managing Database Servers
        • Adding Database Server
        • Changing Database Server Preferences
        • Detaching Database Servers
        • Setting Default Database Server
        • Retrieving Default Database Server Info
        • Retrieving Database Server Parameters
        • Retrieving Supported Types Of Databases
        • Retrieving Local Database Servers Info
      • Managing Databases
        • Available Filters
        • Creating Databases
        • Deleting Databases
        • Retrieving Information About Databases
        • Moving Databases to Another Subscription
        • Assigning Default Database Users
        • Retrieving Default Database User Info
        • Creating Database Users
        • Changing Credentials, Access Rules, and User Roles
        • Retrieving Database Users Info
        • Deleting Database Users
      • Managing DNS
        • Available Filters
          • aclFilter
          • simpleFilter
          • dnsSelectionFilter
          • dnsIpSelectionFilter
        • Managing DNS Records
          • Adding DNS Record
          • Adding a single DNS record
          • Adding multiple DNS records
          • Retrieving DNS Records
          • Retrieving a single DNS record
          • Retrieving multiple DNS records
          • Deleting DNS Records
          • Deleting a single DNS record
          • Deleting multiple DNS records
        • Managing ACL
          • Retrieving ACL
          • Adding Hosts to ACL
          • Adding a single host to ACL
          • Adding a host to ACL twice
          • Removing Host From ACL
          • Removing a single host from ACL
          • Removing a host from ACL two twice
        • Managing SOA Records and Zone Parameters
          • SOA Parameters
          • Updating SOA Record
          • Updating a single SOA record
          • Updating multiple SOA records
          • Retrieving Parameters of SOA Record and Zone
          • Retrieving the zone type and zone status of a site
          • Retrieving the SOA record, zone type, and zone status of a site
          • Retrieving a zone type, and zone status of a site and a domain alias
        • Synchronyzing DNS Zones with Template
        • Managing Name Servers
          • Switching Name Server Mode
          • Changing status of a single name server
          • Changing status of multiple name servers
          • Adding Primary Name Server
          • Adding a single primary name server
          • Adding multiple primary name servers
          • Retrieving Primary Name Servers
          • Retrieving a single name server
          • Retrieving multiple name servers
          • Deleting Primary Name Servers
          • Removing a single name server
          • Removing multiple name servers
        • Managing Local or Remote DNS Servers
          • Enabling Local DNS
          • Enabling the local DNS for two zones
          • Enabling the local DNS for the DNS zone template
          • Disabling Local DNS
          • Disabling the local DNS for two zones
          • Disabling the local DNS for the DNS zone template
          • Enabling Remote DNS Support
          • Disabling Remote DNS Support
          • Retrieving Remote DNS Status
        • Managing DNS Recursion
          • Setting Recursion Type
          • Allowing all recursive requests to the local DNS server
          • Allowing recursive requests from the local net to the local DNS server
          • Retrieving Recursion Type
          • Retrieving Supported Recursion Types
      • Managing FTP Accounts
        • FTP Account Permissions
        • Available Filters
        • Creating FTP Accounts
        • Retrieving Information On FTP Accounts
        • Changing FTP Account Settings
        • Deleting FTP Accounts
      • Managing Git Repositories
        • Retrieving Information on Git Repositories
        • Creating a Git Repository
        • Updating a Git Repository Settings
        • Removing a Git Repository
        • Deploying Changes from a Git Repository
        • Fetching the Remote Repository
      • Managing IP Addresses
        • Adding IP Address
        • Retrieving IP addresses
        • Updating IP Address Properties
        • Removing IP
      • Managing Locales
        • LP Names
        • Available Filters
        • Retrieving List of LP’s
        • Retrieving Localized Messages
        • Enabling LP
        • Disabling LP
        • Locale Codes
      • Managing Log Rotation on Domain
        • Log Rotation Settings
        • Available Filters
        • Changing Log Rotation Settings
        • Retrieving Log Rotation Settings
        • Enabling Log Rotation Service
        • Disabling Log Rotation Service
        • Checking Status of Log Rotation Service
      • Managing Mail
        • Mail Service Preferences
        • Mail Account Settings
          • Mail Box Settings
          • Forwarding Settings
          • Automatic Response Settings
        • Available Filters
        • Creating Mail Accounts
        • Modifying Mail Account Settings
        • Getting Mail Account Settings
        • Deleting Mail Accounts
        • Enabling/Disabling Mail Service on Domain
        • Setting Mail Service Preferences
        • Getting Mail Service Preferences
        • Renaming Mail Accounts
        • Cleaning Mail Queue
      • Managing Node.js Versions
        • Retrieving List of Node.js Versions
        • Enabling Node.js
        • Disabling Node.js
        • Setting Node.js Version on a Domain
        • Retrieving Node.js Version on a Domain
      • Managing PHP Handlers
        • Retrieving PHP Handlers
        • Enabling PHP Handlers
        • Disabling PHP Handlers
        • Displaying PHP Handler Usage
      • Managing Plesk Administrator Information
      • Managing Plesk Components
        • Retrieving Components List
        • Installing Components
      • Managing Plesk Extensions
        • Installing Plesk Extensions
        • Calling Extensions Operations
        • Retrieving Information on Installed Extensions
        • Uninstalling Plesk Extensions
      • Managing Plesk License
        • Retrieving License Key
        • Retrieving Additional License Keys
        • Installing License Key
        • Installing Additional License Keys
        • Reverting to Previous License Key
      • Managing Plesk Server
        • Server Preferences and Global Mail Settings
        • Restricted Domain Names
        • Setting Server Preferences
        • Retrieving Server Preferences
        • Getting Supported Protocols
        • Performing Initial Server Setup
        • Rebooting the Server
        • Getting Server Information
          • Request Packet Structure and Samples
          • Response Packet Structure and Samples
            • License Key
            • General Information
            • Components
            • Server Statistics
              • Plesk Objects
              • Plesk And OS Version
              • Miscellaneous Statistics
              • CPU Usage
              • Memory Usage
              • Swap Usage
              • Disk Space Usage
              • Response Samples
            • Interfaces
            • Services State
            • Shells
            • Session Settings
            • Site Isolation Settings
            • Information about Updates
            • List of Domains
            • List of SSL/TLS certificates
        • Setting Up Server
        • Creating Session Tokens
        • Managing Additional Administrator Accounts
          • Creating Additional Administrator Account
          • Setting Up Additional Administrator Account
          • Deleting Additional Administrator Account
          • Deleting single administrator account
      • Managing Plesk Services
      • Managing Reseller Accounts
        • Reseller Settings
          • General Reseller Account Settings
            • Type ResellerAddGenInfo
            • Type ResellerSetGenInfo
            • Type ResellerGetGenInfo
          • Limits
          • Permissions
          • Subscription Statuses and Associated Plans
        • Available Filters
        • Creating Reseller Accounts
        • Updating Reseller Account Settings
        • Retrieving Information on Reseller Accounts
        • Removing Reseller Accounts
        • Adding IP Addresses to Reseller’s IP Pool
        • Removing IP Addresses from Reseller’s IP Pool
        • Changing IP Address Type in Reseller’s IP Pool
        • Viewing Buttons Displayed on Reseller’s Home Page in Control Panel
        • Retrieving Descriptor of Limits
        • Retrieving Descriptor of Permissions
        • Switching Reseller Accounts to Different Reseller Plans
        • Syncing Reseller Accounts with Reseller Plans
        • Including an App in a Reseller Account
        • Excluding an App from a Reseller Account
        • Including All Apps in a Reseller Account
        • Excluding All Apps from a Reseller Account
        • Retrieving the List of Reseller’s Domains
      • Managing Reseller Plans
        • Reseller Plan Settings
          • Limits
          • Permissions
          • IP Pool Settings
        • Available Filters
        • Creating Reseller Plan
        • Retrieving Information About Reseller Plans
        • Removing Reseller Plans
        • Setting Reseller Plan Properties
        • Adding Application to Reseller Plan
        • Removing Application From reseller Plan
        • Including All Apps in a Reseller Plan
        • Excluding All Apps from a Reseller Plan
        • Creating a Copy of a Reseller Plan
        • Converting Resellers into Customers
      • Managing Secret Keys
        • Creating Secret Keys
        • Retrieving Information on Secret Keys
        • Deleting Secret Keys
      • Managing Service Plans
        • Service Plan Settings
          • Mail Settings
          • Log Rotation Settings
          • Preferences
          • Performance Settings
          • Limits
          • Permissions
          • Hosting Settings
          • PHP Settings
          • Web Server Settings
          • Additional Services
          • Available Applications
        • Available Filters
        • Creating a Service Plan
        • Getting Information on Service Plans
        • Deleting Service Plans
        • Configuring Service Plan Settings
        • Including an App in a Service Plan
        • Excluding an App From a Service Plan
        • Including All Apps in a Service Plan
        • Excluding All Apps from a Service Plan
        • Adding Additional Services to Service Plan
        • Removing Additional Services From Service Plan
        • Retrieving Descriptor of Limits
        • Retrieving Descriptor of Permissions
        • Retrieving Descriptor of Hosting Settings
        • Managing Database Servers Available in a Plan
          • Adding Available Database Servers
          • Removing Available Database Servers
          • Retrieving the List of Available Database Servers
        • Creating a Copy of a Service Plan
      • Managing Sessions
        • Retrieving Sessions List
        • Terminating Session
      • Managing Sites (Domains)
        • Available Filters
        • Site Settings
          • General Site Information
            • Node add/gen_setup
            • Node get/gen_info
            • Node set/gen_setup
          • Hosting
          • The List of Website Properties
          • Site Preferences
          • Disk Space Usage
          • Statistics
        • Creating a Site
        • Getting Information About Sites
        • Configuring Site Settings
        • Removing Sites
        • Getting Custom Buttons List
        • Getting Traffic Usage Information
        • Updating Traffic Usage Statistics
        • Getting Descriptors of Hosting Settings
      • Managing Site Aliases
        • Site Alias Settings
        • Available Filters
        • Creating Site Aliases
        • Retrieving Information on Site Aliases
        • Updating Site Aliases Settings
        • Deleting Site Aliases
        • Renaming Site Aliases
        • Retrieving Information On Manageable Services
      • Managing SSL/TLS Certificates
        • Generating Certificates
        • Installing Certificates
        • Deleting Certificates
        • Retrieving List of Certificates
      • Managing Subdomains
        • Available Filters
        • Subdomain Properties
        • Creating Subdomain
        • Retrieving Information on Subdomains
        • Changing Subdomain Settings
        • Removing Subdomain
        • Renaming Subdomain
      • Managing Subscriptions
        • Available Filters
        • Subscription Settings
          • General Subscription Information
            • Node gen_setup
            • Node gen_info (type domainGenInfoType)
            • Node gen_setup (type setGenSetupType)
          • Limits, Permissions and Hosting Settings
            • Hosting Settings
              • Node std_fwd
              • Node frm_fwd
            • Limits
            • Permissions
          • PHP Settings
          • Disk Space Usage Settings
          • Statistics Settings
          • Subscription Preferences
          • Performance Settings
          • Subscription Statuses and Associated Plans
        • Creating a Subscription
        • Getting Information About Subscriptions
        • Deleting Subscriptions
        • Setting Subscription Parameters
        • Getting Custom Buttons List
        • Getting Traffic Usage Information
        • Setting Traffic Settings on a Subscription
        • Retrieving Descriptor of Limits
        • Retrieving Descriptor of Permissions
        • Retrieving Descriptor of Hosting Settings
        • Switching a Subscription to a Different Service Plan
        • Syncing a Subscription with a Service Plan
        • Adding an Add-on Plan to a Subscription
        • Removing an Add-on Plan from a Subscription
        • Adding an Application to a Subscription
        • Removing an Application From a Subscription
        • Adding an Additional Service to a Subscription
        • Removing an Additional Service From a Subscription
        • Enabling Applications Filter
        • Disabling Applications Filter
        • Managing Database Servers Available in a Subscription
          • Adding Available Databases Servers
          • Removing Available Database Servers
          • Retrieving the List of Available Database Servers
      • Managing User Interface (Custom Buttons)
        • Custom Button Settings
          • Owner
          • Properties
          • URL Components
        • Available Filters
          • customButtonFilter
          • BrandingInputFilter
        • Creating Custom Buttons
        • Retrieving Custom Button Settings
        • Removing Custom Buttons
        • Installing Custom Theme
        • Removing Custom Theme
      • Managing Virtual Directories
        • Virtual Directory Settings
          • Virtual Directory Properties
          • Web Application Properties
          • Default Page Properties
        • Creating Virtual Directories
        • Changing Virtual Directory Settings
        • Retrieving Information about a Virtual Directory
        • Removing Virtual Directories
      • Retrieving Action Log Data
        • Retrieving Action Log
        • Retrieving Action Log Parts
        • Retrieving ID of Last Action
      • Representation of Object Descriptor
        • Filters of Descriptors
        • Property Descriptor
          • Extension of Permissions Descriptor
          • Extension of Hosting Settings Descriptor
          • Extension of Limits Descriptor
          • Extension node sample
        • Bind Parameters
      • Uploading Files to Server
        • Uploading Files Using cURL
        • Uploading Files Using PHP
        • Uploading Files Using .NET
        • Response Packet Structure
        • Response Samples
        • Uploading a single package
      • Managing ICP Permits
        • Assigning ICP Permits During Creation
          • Primary Domain
          • Add-on Domain or Subdomain
          • Domain Alias
        • Retrieving ICP Permit Information
          • Primary Domain, Add-on domain, or Subdomain
          • Domain Alias
        • Updating ICP Permit Information
          • Primary Domain, Add-on Domain, or Subdomain
          • Domain Alias
      • Managing Protected Directories
        • Available Filters
        • Creating Protected Directory
        • Changing Protected Directory Properties
        • Removing Protected Directory
        • Retrieving Protected Directory Properties
        • Creating Protected Directory User
        • Changing Protected Directory User Settings
        • Removing Protected Directory User
        • Retrieving Protected Directory User Settings
        • Retrieving Descriptor of Protected Directory Properties
    • Error Codes
      • Reduced List of Error Codes
  • About REST API
XML API Guide
  • Docs »
  • Search


© Copyright Plesk

Built with Sphinx using a theme provided by Read the Docs.