cPanel Personalization API

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 Personalization 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 Personalization module for UAPI.
  name: Personalization
paths:
  /Personalization/get:
    post:
      x-readonly: true
      description: 'This function retrieves the data from an NVData file on disk. cPanel

        NVData is a per-account configuration storage mechanism that you can use to

        maintain persistent cPanel & WHM settings across multiple sessions. This includes

        custom settings for your own themes and plugins.


        **Note:**


        NVData keys and values are limited to 128 and 2048 bytes, respectively.'
      operationId: Personalization-get
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              example:
                names:
                - coffee
                - milk
              properties:
                names:
                  description: List of NVData keys to query the server about.
                  items:
                    type: string
                  type: array
              type: object
        required: true
      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: get
                    type: string
                  module:
                    description: The name of the module called.
                    example: Personalization
                    type: string
                  result:
                    properties:
                      data:
                        example:
                          coffee:
                            reason: OK
                            success: 1
                            value: hot
                          milk:
                            reason: OK
                            success: 1
                            value: cold
                        properties:
                          personalization:
                            additionalProperties:
                              properties:
                                reason:
                                  description: The message that describes the failure if `success` returns `0`, or `OK` if `success` returns `1`.
                                  example: OK
                                  type: string
                                success:
                                  description: "Whether the function successfully retrieved the value from the server.\n  - `1` — Successful.\n  - `0` — Unsuccessful."
                                  enum:
                                  - 0
                                  - 1
                                  example: 1
                                  type: integer
                                value:
                                  description: The value stored for the associated NVData key, or a null value if the key does not exist in the store.
                                  type:
                                  - string
                                  - 'null'
                              type: object
                            description: 'The retrieved NVData information stored on the server.


                              **Note:**


                              * You set this return''s name based on the keys that you provide in the `personalization` parameter with the UAPI `Personalization::set` function.

                              * This return''s name is the NVData key''s name.'
                        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'
                      metadata:
                        properties: {}
                      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 a API.
                        example: null
                        items:
                          type: string
                        type:
                        - array
                        - 'null'
                    type: object
                type: object
          description: HTTP Request was successful.
      summary: Retrieve NVData data from file
      tags:
      - Personalization
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "echo '{\"names\":[\"coffee\",\"milk\"]}' | \\\nuapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Personalization \\\n  get"
      - label: HTTP Request (Wire Format)
        lang: HTTP
        source: 'POST /cpsess##########/execute/Personalization/get HTTP/1.1

          Host: example.com:2083

          Cookie: ###################################

          Content-Type: application/json

          Content-Length: 27


          {"names":["coffee","milk"]}'
      x-cpanel-api-version: UAPI
      x-cpanel-available-version: cPanel 74
  /Personalization/set:
    post:
      x-readonly: false
      x-rollback: none
      description: 'This function saves its data to an NVData file on disk. cPanel

        NVData is a per-account configuration storage mechanism that you can use to

        maintain persistent cPanel & WHM settings across multiple sessions. This includes

        custom settings for your own themes and plugins.


        **Note:**


        NVData keys and values are limited to 128 and 2048 bytes, respectively.'
      operationId: Personalization-set
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              example:
                personalization:
                  coffee: hot
                  milk: cold
              properties:
                personalization:
                  additionalProperties:
                    type: string
                  description: The NVData keys and values to update.
                  type: object
              type: object
        required: true
      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: set
                    type: string
                  module:
                    description: The name of the module called.
                    example: Personalization
                    type: string
                  result:
                    properties:
                      data:
                        example:
                          coffee:
                            reason: OK
                            success: 1
                            value: hot
                          milk:
                            reason: OK
                            success: 1
                            value: cold
                        properties:
                          personalization:
                            additionalProperties:
                              properties:
                                reason:
                                  description: The message that describes the failure if `success` returns `0`, or `OK` if `success` returns `1`.
                                  example: OK
                                  type: string
                                success:
                                  description: "Whether the function successfully saved the value on the server.\n  - `1` — Successful.\n  - `0` — Unsuccessful."
                                  enum:
                                  - 0
                                  - 1
                                  example: 1
                                  type: integer
                                value:
                                  description: The value stored for the associated NVData key, or a null value if the key does not exist in the store.
                                  type:
                                  - string
                                  - 'null'
                              type: object
                            description: 'The saved NVData information stored on the server.


                              **Note:**


                              You set this return''s name based on the keys that you provide in the `personalization` parameter.'
                        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'
                      metadata:
                        properties: {}
                      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 a API.
                        example: null
                        items:
                          type: string
                        type:
                        - array
                        - 'null'
                    type: object
                type: object
          description: HTTP Request was successful.
      summary: Save NVData data to file
      tags:
      - Personalization
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "echo '{\"personalization\":{\"coffee\":\"hot\",\"milk\":\"cold\"}}' | \\\nuapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Personalization \\\n  set"
      - label: HTTP Request (Wire Format)
        lang: HTTP
        source: 'POST /cpsess##########/execute/Personalization/set HTTP/1.1

          Host: example.com:2083

          Cookie: ###################################

          Content-Type: application/json

          Content-Length: 50


          {"personalization":{"coffee":"hot","milk":"cold"}}'
      x-cpanel-api-version: UAPI
      x-cpanel-available-version: cPanel 74
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