openapi: 3.2.0 info: contact: email: cs@cpanel.net name: WebPros International, LLC url: https://cpanel.net/support/ description: UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings. license: name: cPanel License url: https://cpanel.net/legal-notices/ termsOfService: https://cpanel.net/legal-notices/ title: cPanel U Domain API version: 11.137.9999.106 x-api-evangelist-provenance: 'Harvested verbatim from cPanel''s developer portal on 2026-09-05 via the MCP tool get-full-api-description at https://api.docs.cpanel.net/mcp. ONE mechanical change was made before storage: example values containing PEM private-key or certificate blocks, and AWS-access-key-shaped example strings, were replaced with REDACTED_* placeholders so the file can be stored in a public git repository without tripping secret scanning. No path, operation, parameter, schema or description was altered, added or removed.' servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. security: - BasicAuth: [] tags: - description: The Domain module for UAPI. name: Domain paths: /Domain/convert_temporary_to_registered: post: x-readonly: false x-rollback: none description: 'This function converts a temporary domain into a registered domain and moves its document root files to the new document root location. **Note:** * For more information about temporary domains, read our Temporary Domains documentation. * You cannot use this function to convert a cPanel account''s main domain.' operationId: Domain-convert_temporary_to_registered parameters: - description: A valid temporary domain on the account. in: query name: domain required: true schema: example: wonderful-fushsia-owl.10-20-30-40.cpanel.site format: domain type: string - description: A valid domain name. in: query name: registered required: true schema: example: example.com format: domain type: string - description: 'The path to the domain''s document root directory. If you do not specify a value, this parameter defaults to the domain''s name. **Note:** The function will create a symlink in place of the previous temporary domain''s document root directory. The symlink will point to the registered domain''s document root.' in: query name: docroot required: false schema: example: example.com type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: convert_temporary_to_registered type: string module: description: The name of the module called. example: Domain type: string result: properties: data: properties: message: description: A message describing the result of the conversion. example: Domain wonderful-fushsia-owl.10-20-30-40.cpanel.site successfully converted to example.com type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' status: description: '- 1 - Success. - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. example: null items: type: string type: - array - 'null' type: object type: object description: Request was successful. summary: Convert a temporary domain to a registered domain tags: - Domain x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n Domain \\\n convert_temporary_to_registered \\\n domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site \\\n registered=example.com\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/Domain/convert_temporary_to_registered?domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site®istered=example.com x-cpanel-api-version: UAPI x-cpanel-available-version: 130 /Domain/is_temporary_domain: get: x-readonly: true description: 'This function determines whether a domain is temporary. **Note:** For more information about temporary domains, read our Temporary Domains documentation.' operationId: Domain-is_temporary_domain parameters: - description: A domain on the cPanel account. in: query name: domain required: true schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: is_temporary_domain type: string module: description: The name of the module called. example: Domain type: string result: properties: data: description: 'Whether the domain is a temporary domain. * `1` - The domain is a temporary domain. * `0` - The domains is **not** a temporary domain.' enum: - 0 - 1 example: 1 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API call. example: null items: type: string type: - array - 'null' type: object type: object description: Request was successful. summary: Return whether a domain is temporary tags: - Domain x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n Domain \\\n is_temporary_domain \\\n domain=example.com\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/Domain/is_temporary_domain?domain=example.com x-cpanel-api-version: UAPI x-cpanel-available-version: 130 /Domain/rename_domain: post: x-readonly: false x-rollback: none description: 'This function renames a primary domain, addon domain, or alias domain on a cPanel account. The system updates all relevant configuration files, document root paths, and DNS entries automatically. **Note:** * You cannot rename a domain while another rename operation is in progress. * You cannot rename the server hostname. * The new domain must not already be configured on the account.' operationId: Domain-rename_domain parameters: - description: The current domain name to rename. in: query name: domain required: true schema: example: old.example.com format: domain type: string - description: The new domain name. in: query name: new_domain required: true schema: example: new.example.com format: domain type: string - description: 'The path to the domain''s document root directory. If you do not specify a value, this parameter defaults to the new domain name.' in: query name: docroot required: false schema: example: new.example.com type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: rename_domain type: string module: description: The name of the module called. example: Domain type: string result: properties: data: properties: message: description: A message describing the result of the rename. example: Domain old.example.com successfully renamed to new.example.com type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' status: description: '- 1 - Success. - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. example: null items: type: string type: - array - 'null' type: object type: object description: Request was successful. summary: Rename a primary, addon, or alias domain tags: - Domain x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n Domain \\\n rename_domain \\\n domain=old.example.com \\\n new_domain=new.example.com\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/Domain/rename_domain?domain=old.example.com&new_domain=new.example.com x-cpanel-api-version: UAPI x-cpanel-available-version: 138 /Domain/temporary_domain_is_disabled: get: x-readonly: true description: 'This function returns whether the temporary domains feature is disabled by server configuration. **Note:** For more information about temporary domains, read our Temporary Domains documentation.' operationId: Domain-temporary_domain_is_disabled parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: temporary_domain_is_disabled type: string module: description: The name of the module called. example: Domain type: string result: properties: data: description: 'An object containing the disabled state of the temporary domains feature.' properties: is_disabled: description: 'Whether temporary domains are disabled by server configuration. * `1` - Temporary domains are disabled. * `0` - Temporary domains are enabled.' enum: - 0 - 1 example: 0 type: integer type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API call. example: null items: type: string type: - array - 'null' type: object type: object description: Request was successful. summary: Return whether temporary domains are disabled tags: - Domain x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n Domain \\\n temporary_domain_is_disabled\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/Domain/temporary_domain_is_disabled x-cpanel-api-version: UAPI x-cpanel-available-version: 138 components: securitySchemes: BasicAuth: scheme: basic type: http externalDocs: url: https://cpanel.net/developers/ x-tagGroups: - name: API Development Tools tags: - API Token Management - Batch - SSE Task Management - URL Parsing - name: Authentication tags: - External Authentication - Two-Factor Settings - name: Backup Information tags: - BackupInfo - BackupInfo Status - name: Block Ip Addresses tags: - Block IP - name: Commerce Integration tags: - Market Integration - SSL Certificates - name: Contact Information tags: - Contact Information - name: cPanel Account tags: - Account Enhancements - Account Information - Account Management - AuditLog - Contact Information - cPanel Features - Disk Quotas - DomainRecommendations - Personalization - Resource Usage and Statistics - Subaccount Management - Team Roles - Team Users - name: cPanel Account Backups tags: - Backup - File Restoration - name: cPanel Plugin Framework tags: - Formbricks - Plugins - name: cPanel Theme Management tags: - Application Information - Brand Management - Branding Files - Browser Cache Management - Language - Theme Settings - name: Directory Management tags: - Directory Indexes - Directory Privacy - Directory Protection - name: DNS tags: - DNS - DNS Information - DNS Security - Dynamic DNS - Email DNS Settings - ZoneEdit - name: Domain tags: - Domain - name: Domain Management tags: - AddonDomain - Direct Link Protection (Hotlink) - Domain - Domain Information - Domain Redirection - DomainLookup - Park - SubDomain - Virtual Host Information - name: Domains tags: - Subdomains - name: Email tags: - Email Accounts - Email Filtering - Email Forwarding - Email Server Information - Email Suspensions - Mail Server Information - Mailbox Management - Mailing Lists - Signing and Encryption (GnuPG Keys) - Spam Filtering (Greylisting) - Spam Management - Spam Prevention (BoxTrapper) - Webmail Applications - Webmail Sessions - name: Extract Information tags: - ExtractInfo - ExtractInfo Status - name: File Manager tags: - Trash - name: Files tags: - FTP Accounts - FTP Server Settings - Image Tools - Jodit - Manage Files - Manage Files - WebDisk Settings - name: GIT Management tags: - Deployment Settings - Repository Management - name: InProductSurvey tags: - InProductSurvey - name: MySQL and MariaDB tags: - Database Information - Database Management - Remote Databases - User Management - name: Notifications tags: - Pushbullet - name: Optional Applications tags: - Antivirus Protection (ClamAV) - Calendar and Contacts (DAV) - Calendar and Contacts Server - WordPress Manager Backups - name: PostgreSQL tags: - PostgreSQL Database Management - PostgreSQL User Management - name: Retrieve bandwidth information tags: - Bandwidth - name: Security tags: - Known SSH Hosts Management - Login Information - name: Server Information tags: - cPanel Server Information - Notifications - Password Strength - SSH - WebPros MCP - WebProsMCP - name: ServiceProxy tags: - ServiceProxy - name: Site Quality Monitoring tags: - SiteQuality - name: SSL Certificates tags: - Auto-generated SSL Certificates - cPanel Account SSL Management - SNI Email Settings - SSL Certificate Management - Verify Domain Ownership - name: Statistics tags: - Domain Statistics - Weblog Settings - name: UserData tags: - UserData - name: Web Server Configuration tags: - EA4 - EasyApache Settings - PHP - name: Web Server Management tags: - Application Manager - ModSecurity - NginxCaching - PHP Settings - Web Apps - name: Website Configuration tags: - Handler Management - Logs - Mime Type Management - Nova - Site Information - Site Installation - Sitejet - WPX