cPanel Features 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 Features 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 Features module for UAPI.
  name: Features
paths:
  /Features/get_feature_metadata:
    get:
      x-readonly: true
      description: This function lists the details of a cPanel account's available feature lists.
      operationId: Features-get_feature_metadata
      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: get_feature_metadata
                    type: string
                  module:
                    description: The name of the module called.
                    example: Features
                    type: string
                  result:
                    properties:
                      data:
                        description: An array of objects containing feature information.
                        items:
                          properties:
                            id:
                              description: The feature's system ID.
                              example: wordpress_manager
                              type: string
                            is_plugin:
                              description: 'Whether the feature is a [plugin](https://go.cpanel.net/cpanelplugin).


                                * `1` — Plugin.

                                * `0` — **Not** a plugin.'
                              enum:
                              - 1
                              - 0
                              example: 1
                              type: integer
                            name:
                              description: The feature's name.
                              example: WordPress Manager
                              type: string
                          type: object
                        type: array
                      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:
                        - 1
                        - 0
                        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: Return cPanel account's features' metadata
      tags:
      - Features
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  get_feature_metadata\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2083/cpsess##########/execute/Features/get_feature_metadata
      - label: LiveAPI Perl
        lang: Perl
        source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_get_feature_metadata.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_get_feature_metadata.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/get_feature_metadata/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"
      - label: LiveAPI PHP
        lang: PHP
        source: "<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_get_feature_metadata.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_get_feature_metadata.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'get_feature_metadata'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"
      x-cpanel-api-version: UAPI
      x-cpanel-available-version: cPanel 80
  /Features/has_feature:
    get:
      x-readonly: true
      description: 'This function checks whether a cPanel account has access to

        a feature.'
      operationId: Features-has_feature
      parameters:
      - description: The feature's name.
        in: query
        name: name
        required: true
        schema:
          example: autossl
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                does-not-have-feature:
                  summary: The account does not have a feature.
                  value:
                    result:
                      data: null
                      errors: null
                      messages: null
                      metadata: {}
                      status: 0
                      warnings: null
                exists-but-acct-does-not-have:
                  summary: The feature exists but the account does not have it enabled.
                  value:
                    result:
                      data: null
                      errors: null
                      messages:
                      - The feature “autossl” exists but is not enabled.
                      metadata: {}
                      status: 0
                      warnings: null
                has-feature:
                  summary: The account has a feature.
                  value:
                    result:
                      data: null
                      errors: null
                      messages: null
                      metadata: {}
                      status: 1
                      warnings: null
              schema:
                properties:
                  apiversion:
                    description: The version of the API.
                    example: 3
                    type: integer
                  func:
                    description: The name of the method called.
                    example: has_feature
                    type: string
                  module:
                    description: The name of the module called.
                    example: Features
                    type: string
                  result:
                    properties:
                      data:
                        default: null
                        type:
                        - object
                        - 'null'
                      errors:
                        description: List of errors if the API failed.
                        example: null
                        items:
                          type: string
                        type:
                        - array
                        - 'null'
                      messages:
                        description: 'A message about the feature''s status.


                          **Note:**


                          The function only returns a message when the feature exists but

                          it is **not** enabled.'
                        example: null
                        items:
                          type: string
                        type:
                        - array
                        - 'null'
                      metadata:
                        properties: {}
                      status:
                        description: 'Whether the feature exists on the system.


                          * `1` — The feature exists on the system and it is enabled.

                          * `0` — The feature exists on the system, but the user does **not** have it.

                          * `null` — The feature is **not** installed on the system.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type:
                        - integer
                        - 'null'
                      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
          description: HTTP Request was successful.
      summary: Validate cPanel account's feature access
      tags:
      - Features
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  has_feature \\\n  name='autossl'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2083/cpsess##########/execute/Features/has_feature?name=autossl
      - label: LiveAPI Perl
        lang: Perl
        source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_has_feature.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_has_feature.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/has_feature/,\n    {\n        'name' => 'autossl',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"
      - label: LiveAPI PHP
        lang: PHP
        source: "<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_has_feature.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_has_feature.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'has_feature',\n    array (\n        'name' => 'autossl',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"
      x-cpanel-api-version: UAPI
      x-cpanel-available-version: cPanel 11.42
  /Features/has_features_like:
    get:
      x-readonly: true
      description: 'This function allows you to search for cPanel account features and determine whether those features

        are enabled.'
      operationId: Features-has_features_like
      parameters:
      - description: 'The feature''s name that you wish to search.


          **Note:**


          To use a regular expression, you must set the `is_regex` parameter''s value to `true`.'
        in: query
        name: pattern
        required: true
        schema:
          example: mail
          type: string
      - description: 'Whether the `pattern` parameter''s value is a regular expression.

          *  `1` - The `pattern` parameter''s value is a regular expression.

          *  `0` - The `pattern` parameter''s value is **not** a regular expression'
        in: query
        name: is_regex
        required: false
        schema:
          default: 0
          enum:
          - 0
          - 1
          example: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                has-enabled-features:
                  summary: Pattern matches enabled features
                  value:
                    result:
                      data:
                        has_matching_features: 1
                      errors: null
                      messages: null
                      metadata: {}
                      status: 1
                      warnings: null
                no-enabled-features:
                  summary: Pattern matches features but none are enabled
                  value:
                    result:
                      data:
                        has_matching_features: 0
                      errors: null
                      messages: null
                      metadata: {}
                      status: 1
                      warnings: null
                no-matches:
                  summary: No features match the pattern
                  value:
                    result:
                      data:
                        has_matching_features: 0
                      errors: null
                      messages: null
                      metadata: {}
                      status: 1
                      warnings: null
                missing-pattern:
                  summary: Pattern parameter is required
                  value:
                    result:
                      data: null
                      errors:
                      - '"pattern" is required'
                      messages: null
                      metadata: {}
                      status: 0
                      warnings: null
              schema:
                properties:
                  apiversion:
                    description: The version of the API.
                    example: 3
                    type: integer
                  func:
                    description: The name of the method called.
                    example: has_features_like
                    type: string
                  module:
                    description: The name of the module called.
                    example: Features
                    type: string
                  result:
                    properties:
                      data:
                        description: Object containing the result of the feature search.
                        properties:
                          has_matching_features:
                            description: 'Whether any features match the search pattern and are enabled.

                              * `1` - At least one matching feature is enabled.

                              * `0` - No matching features are enabled (either no matches or all matches are disabled).'
                            enum:
                            - 0
                            - 1
                            example: 1
                            type: integer
                        example:
                          has_matching_features: 1
                        type:
                        - object
                        - 'null'
                      errors:
                        description: 'List of errors if the API failed.


                          Common errors include missing pattern parameter or invalid regular expression syntax.'
                        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: 'Whether the API call was successful.

                          * `1` - Success. Features were searched and results returned.

                          * `0` - Failed. Check the `errors` field for details (e.g., missing pattern).'
                        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
          description: HTTP Request was successful.
      summary: Return whether queried features are enabled
      tags:
      - Features
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  has_features_like \\\n  pattern='mail'\n"
      - label: CLI (Regex)
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  has_features_like \\\n  pattern='^ssl.*' \\\n  is_regex=1\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2083/cpsess##########/execute/Features/has_features_like?pattern=mail
      - label: URL (Regex)
        lang: HTTP
        source: https://hostname.example.com:2083/cpsess##########/execute/Features/has_features_like?pattern=%5Essl.*&is_regex=1
      - label: LiveAPI Perl
        lang: Perl
        source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_has_features_like.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_has_features_like.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/has_features_like/,\n    {\n        'pattern' => 'mail',\n        'is_regex' => 0,\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"
      - label: LiveAPI PHP
        lang: PHP
        source: "<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_has_features_like.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_has_features_like.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'has_features_like',\n    array (\n        'pattern' => 'mail',\n        'is_regex' => 0,\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"
      x-cpanel-api-version: UAPI
      x-cpanel-available-version: cPanel 11.130
  /Features/list_features:
    get:
      x-readonly: true
      description: This function lists a cPanel account's features.
      operationId: Features-list_features
      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: list_features
                    type: string
                  module:
                    description: The name of the module called.
                    example: Features
                    type: string
                  result:
                    properties:
                      data:
                        additionalProperties:
                          description: 'Whether the feature is installed.

                            * `1` - Installed.

                            * `0` - **Not** installed.'
                          enum:
                          - 0
                          - 1
                          example: 0
                          type: integer
                        description: 'Features available to the account. The key is a feature name and the value

                          is whether the feature is installed.


                          **Note:**


                          This function returns features that third-party software or plugins provide.'
                        example:
                          bbs: 0
                          blockers: 1
                          boxtrapper: 1
                          changemx: 1
                          chat: 0
                          defaultaddress: 1
                          email_disk_usage: 1
                          emailarchive: 1
                          emailauth: 1
                          emaildomainfwd: 1
                          emailtrace: 1
                          popaccts: 1
                          spamassassin: 1
                          spambox: 1
                          traceaddy: 1
                          updatecontact: 1
                          webmail: 1
                        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: Return cPanel account's features
      tags:
      - Features
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  list_features\n"
      - label: URL
        lang: 

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-features-api-openapi.yml