openapi: 3.2.0
info:
  title: Cpanel Integration API
  version: 11.137.9999.106
  contact:
    email: cs@cpanel.net
    name: WebPros International, LLC
    url: https://cpanel.net/support/
  license:
    name: cPanel License
    url: https://cpanel.net/legal-notices/
  termsOfService: https://cpanel.net/legal-notices/
  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.'
  description: 'Operations tagged Integration across 2 of this provider''s published API definitions: cpanel-uapi-openapi.yml, cpanel-whm-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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.
- description: A server running WHM.
  url: https://{host}:{port}/json-api
  variables:
    host:
      default: whm-server.tld
      description: The hostname of a server running WHM.
    port:
      default: '2087'
      description: The WHM port.
security:
- BasicAuth: []
tags:
- description: The Integration module for UAPI.
  name: Integration
paths:
  /Integration/fetch_url:
    get:
      x-readonly: false
      x-rollback: none
      description: This function returns the URL for an integrated application.
      operationId: Integration-fetch_url
      parameters:
      - description: The application's name.
        in: query
        name: app
        required: true
        schema:
          example: applicationname
          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: fetch_url
                    type: string
                  module:
                    description: The name of the module called.
                    example: Integration
                    type: string
                  result:
                    properties:
                      data:
                        properties:
                          redirect_url:
                            description: The publicly-available URL to which the application will redirect visitors.
                            example: http://application.example.com/application
                            format: url
                            type: string
                          url:
                            description: The publicly-available URL to which the application redirects visitors if the `redirect_url` location is unavailable.
                            example: http://application.example.com/
                            format: url
                            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'
                      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 integrated application URL
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "uapi --output=jsonpretty \\\n  --user=username \\\n  Integration \\\n  fetch_url \\\n  app='applicationname'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2083/cpsess##########/execute/Integration/fetch_url?app=applicationname
      - 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 Integration_fetch_url.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/Integration_fetch_url.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/Integration/,\n    q/fetch_url/,\n    {\n        'app' => 'applicationname',\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 Integration_fetch_url.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/Integration_fetch_url.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    'Integration',\n    'fetch_url',\n    array (\n        'app' => 'applicationname',\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 54
    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.
  /create_integration_group:
    get:
      description: This function creates a group to store integrations links in the cPanel interface.
      operationId: Integration-create_integration_group
      parameters:
      - description: "The group's ID within the system.\n\n**Warning:**\n\n If you create a link with a `group_id` value that already exists, the function replaces the existing group with the newly-created group."
        in: query
        name: group_id
        required: true
        schema:
          example: WHMCS
          type: string
      - description: The label for the group to display in the cPanel interface.
        in: query
        name: label
        required: true
        schema:
          example: WHMCS+Control
          type: string
      - description: "The order in which to display the group in the cPanel interface.\n\n**Note:**\n\n By default, the function will automatically create an item under the username menu in the interface header."
        in: query
        name: order
        required: true
        schema:
          example: 1
          minimum: 1
          type: integer
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: create_integration_group
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
                        example: Ok
                        type: string
                      result:
                        description: '* `1` - Success

                          * `0` - Failed: Check the reason field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Create integration link group
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  create_integration_group \\\n  user='username' \\\n  group_id='WHMCS' \\\n  label='WHMCS+Control' \\\n  order='1'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2bControl&order=1
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /create_integration_link:
    get:
      description: 'This function creates an integration link in the cPanel interface.


        **Note:**


        The function creates the `APP.adminconfig` and `APP.userconfig` integration link files in the `/var/cpanel/integration/links/USERNAME` directory, where `APP` represents the application name and `USERNAME` represents the user for whom you create integration links.'
      operationId: Integration-create_integration_link
      parameters:
      - description: 'The application to link.


          **Note:**

          * If you create a link with an `app` value that already exists, the function will replace the existing link with the newly-created link.

          * The value you assign to the `app` parameter is how you identify that integration link when listing or removing integration links.

          * You may include underscore (`_`) characters.'
        in: query
        name: app
        required: true
        schema:
          example: WHMCS_billing
          type: string
      - description: 'The service for which to implement authentication.


          **Note:**


          This is a string from the `get_users_links` function. The function typically returns one of the following values.


          * `billing` - This link appears in the user menu

          * `customer_service` - This link appears in the user menu

          * `support` - This link appears in the user menu

          * `upgrade` - This link appears in the user menu and context-sensitive areas when the user may require more of a resource'
        in: query
        name: implements
        required: true
        schema:
          example: billing
          type: string
      - description: The label to display in the cPanel login interface.
        in: query
        name: label
        required: true
        schema:
          example: WHMCS Billing
          type: string
      - description: The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.
        in: query
        name: subscriber_unique_id
        required: true
        schema:
          example: '1234'
          type: string
      - description: The token that the system will present to the URL in the `autologin_token_url` endpoint.
        in: query
        name: token
        required: true
        schema:
          example: subway
          type: string
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      - description: 'The URL to which the server will send the `app`, `token`, `user`, and `subscriber_unique_id` values through an `HTTP POST` request. The destination server will respond with a JSON-encoded object with either a `redirect_url` key or the `retry` and `attempt` keys.


          **Note:**


          * You **must** include either the `autologin_token_url` parameter, the `url` parameter, or both.

          * If you do not set the `autologin_token_url` parameter, or that server does not respond or exist, then the server will redirect the user to the location in the `url` parameter.

          * If the response contains `redirect_url`, the system will redirect the user to that URL. (For example:, `{"redirect_url":" http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00 ”}` will send the user to that unique URL.)

          * If the response contains `retry` and `attempt`, the system will wait for the retry value in seconds for a maximum of 60 seconds and then attempt the call again. The attempt value indicates the number of attempts that your system has tried. The system will stop after three attempts. (For example, `{"retry":30, "attempt":2}` represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again.)'
        in: query
        name: autologin_token_url
        required: false
        schema:
          example: http://www.example.com/login.cgi
          format: json
          type: string
      - description: 'The icon image.


          **Note:**


          If you **do not** specify a value, the interface uses a standard puzzle piece icon.'
        in: query
        name: base64_png_image
        required: false
        schema:
          example: iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB 3d3cuaW5rc2NhcGUub3Jnm+48GgAAAUNJREFUeJztziFKg2EABuD3+ydz qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8 DwneJI/6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD+/LJNsWv6x5Z p6NbzJ/sF7uj/3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk+eUvOS 4v2g7x/bbSamPSecuqZ+p5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0 WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC
          format: base64 image
          type: string
      - description: 'The group ID in which to add the icon of the linked service.


          * `files`

          * `databases`

          * `domains`

          * `email`

          * `metrics`

          * `security`

          * `software`

          * `advanced`

          * `pref`


          **Note:**


          If you **do not** specify a value, the function automatically creates an item under the username menu in the interface header.'
        in: query
        name: group_id
        required: false
        schema:
          enum:
          - files
          - databases
          - domains
          - email
          - metrics
          - security
          - software
          - advanced
          - pref
          example: advanced
          type: string
      - description: "Whether the cPanel interface will display the integration link.\n\n * `1` - Do **not** display the link.\n * `0` - Display the link."
        in: query
        name: hide
        schema:
          default: 0
          enum:
          - 0
          - 1
          example: 1
          type: integer
      - description: The order in which to display the icon in the cPanel interface inside the `group_id` group.
        in: query
        name: order
        required: false
        schema:
          example: '999'
          type: string
      - description: 'The URL to which to send the user if the `autologin_token_url` location does not respond or is not present.


          **Note:**


          * You **must** include either the `autologin_token_url` parameter, the `url` parameter, or both.'
        in: query
        name: url
        required: false
        schema:
          example: http://www.example.com
          format: url
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: create_integration_link
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
                        example: Ok
                        type: string
                      result:
                        description: '* `1` - Success

                          * `0` - Failed: Check the reason field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Create integration link
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  create_integration_link \\\n  user='username' \\\n  app='WHMCS_billing' \\\n  token='subway' \\\n  implements='billing' \\\n  label='WHMCS Billing' \\\n  subscriber_unique_id='1234'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/create_integration_link?api.version=1&user=username&app=WHMCS_billing&token=subway&implements=billing&label=WHMCS%20Billing&subscriber_unique_id=1234
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /get_integration_link_user_config:
    get:
      description: This function retrieves configuration information about a specified integration link in a specified user's cPanel interface.
      operationId: Integration-get_integration_link_user_config
      parameters:
      - description: 'The integration link''s app name.


          **Warning:**


          If you create a link with an app value that already exists, the function will replace the existing link with the newly-created link.'
        in: query
        name: app
        required: true
        schema:
          example: WHMCS_billing
          type: string
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      userconfig:
                        description: An object with information about the user's integration link.
                        properties:
                          app:
                            description: The application to link.
                            example: WHMCS_billing
                            type: string
                          autologin_token_url:
                            description: 'A publicly-available URL to which the server will send the

                              `app`, `token`, `user`, and `subscriber_unique_id` values through

                              an HTTP POST request. The destination server will respond

                              with a JSON-encoded object with either a `redirect_url`

                              key or the `retry` and `attempt` keys.


                              * If the response contains `redirect_url`, the system will redirect

                              the user to that URL (for example, `{"redirect_url":"http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00}`

                              will send the user to that URL).

                              * If the response contains `retry` and `attempt`, the system will wait for

                              the `retry` value in seconds for a maximum of 60 seconds

                              and then attempt the call again. The `attempt` value indicates

                              the number of attempts that the system tried. The system

                              will stop after three attempts (for example, `{"retry":30,

                              "attempt":2}` represents the second attempt to connect,

                              and the system will pause the user for 30 seconds before

                              it tries again).'
                            example: http://www.example.com/login.cgi
                            format: url
                            type: string
                          base64_png_image:
                            description: The image to display for the application on the cPanel *Home* interface.
                            example: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QA%2fwD%2fAP%2bgvaeTAAAACXBIWXMAAABIAAAASABGyWs%2bAAALVUlEQVRo3sWZe3BU1R3HP79z793dZAPkBYIg4RUSBKkIEfCNog5WbaWOHevUWttOVXxVtFWctmpb2xGptVOt1ken1bbSVsVSxVba8UkrsRIxYhbRJEqRVxJCErK7d%2b89%2fePcTW6WTdj4mH5nLuTunj3n%2b%2f2d3%2fn9fucc4f%2bAbdu2ISJkMhmxbXupiMwH0lrr33qet7W6uhoRKaivwlp9TCQSCQAFVAEdwL7gqxLgCeB0wAOuSqVSvywvLyeZTIrWeqLWukdrvVcpRXV19UF9q0%2bbeEC%2bEvgOsA74EVAaNBkP1AR%2fW0BdNBq1enp68Dyvzvf9P2qtVwNn%2bb5vh%2frrg%2f1JEP3hG0ehROFpt8qW2CLAymRceax7aXeHv2PtFSM3LtD4NwNxYAqQAn4CnAwcFupqLjADiAG%2fAOqCz2PAq0Bb7tjDFrC8Pj7gfVVdD%2b3p9xAUoJcCKzGuKUCHhWyPSWmiV7fvCQQ4wGXAKcAEIBrqbibweMBrSujzt4HOfHwKEhAiXR5YqQHYs6quJ%2fSdHwGOxbgCGg8NZQp7zhGxyvu39rY3AJOCxkXAnDxDWcD0nM9c4AUgA1BTUzPgyyEFhIhHgcXA1cBC4DHgxuX18fZQ89HALNBEZRRTnDPo8rdLt79r4aaelx%2bLqzHJ%2fKMIAmjo%2bzePAA8oBiYlEok6YNf06dP%2f1tTUpAeNQiHyDnAT8C36F18G%2bBWwgv6pPQVYo9GjjopcxMLYcjxSpPzO9mI1%2bg1BzQ9IBLQVGk1ad%2bFyAIfiroiUKIyb5aIFeAeoBQ4HtsZisQs6OzsbC3EhDUwMkc%2fO3DeAJPCDYOoXa%2fTImIximrMECxtBcFRRuUYvClscNHu8LWxzn2Gn9wZJ3ZGptI788ZLiu193de%2fZwNKAaBaT6Hc%2fgFrP886ePXt2YyEzAPAV4EEOdrle4EWgDBM9RgiKGudc5seuJSalaPwca3i8nX6CTakH6dY7s6J2CNaSmJRtvnjEehs4HrgDs6YOgoisi0QiV2%2fdunXboHlgVV1P%2bPU1YGeeZkXAmcFAIwxBnyZ3DRuSK%2bnVbYRzpSAk3LX8O3UX3XoXgpV93qpQ1c0%2bKTDu%2bQJwObAlD%2flnIpHIsmQyuW3u3LkFJ7IWYHMhDTUaH49t7jr2eFtQwRCCYp%2ffQkPqYVx9IAi7Bgr7lRV7NnWNsWbj6TTj7em0%2bTteV9h3YnJGFp7jOGu6urqaa2trqaioMC4RcpdRmOy4HeiiPyz0AE3AWUORFxRFUspIdQSHWUdTYdUOcKGWzPN0%2bu8PII9xwzevLIe4jOXp3m8y0T3Bakg9UjbZXtxyYtGN7yjsWUFby%2fO8C%2bPx%2bIetra2NjuPsskPkFbAMuCIg%2b0rwvAXMAs4e2vI%2bY61jOD72bUaq8ThS0jcjAB5pdmU2o9G5BVjMx%2f16qapqas48l3b1gTm7M1tO8MksTLhrKqY4i9RE%2b8Q%2bQ3iet8jzvAWu625Pp9OvhRflvMDvxgfPqYHlWzERaPyhXKdYjabCmg6hyJ6dG1%2b7JPW%2bfNWjAGcmdftUjW8D4zV%2b1PTp0eE36ypOys0QRUC17%2fsVWQGxgPyEnI5LMOn9UOgE%2fVpMStuA00GPYkChqBGxsCWGJm8JrDR%2bbgZGUDgUDRYpXRFpywqIMzDuFooU8HfgXl%2b7G%2bZELvFdfWCuEmeuhXMccAZBdLKJUmnVpj7IvGwTlBtDQ%2bNInDJrygDrK6UaReRZy7I2KaW2ZK3Uhil3XxkG%2bX3AbcDFwLO2FO0%2fZsZJ3TEpewH4KfA1TAUZ0IGZkS82l8i4J0GnDtW5j88Y6ygqVE04EHiWZd3V2Nh4w6RJk35fVVXVoELxvgFTJb5QAPku4LuYynPfqrqeUN7QaDIIMh0YF7ZoiYydtLTkd42C%2fQDozOC29ymSCj4T%2bTIRKSG0nsTzvCPr6upKWltb0VobPw2JaAxE%2fHNI48B9wAOAm%2f3t9fUjeP6tPzDtzclYRI7TcD8560fjx4pl9GXnl6xuUTjrNV6YXF8OKZZKFsSu1RPs43IzufJ9%2f8re3t7bo9FoZSKR6F9oIRFNwBoGKQ2BTZjNxkFuMNk5jddnvlSpsG8Hna9cRuOPLVfTVpxVfE%2fZYdacdERGoLBROMRlNNOcM1lcfAc1zrmDLd6o53lX9Pb2XlpbW9tf24TyQTFwDPn3yz7wKPB%2bvp5TuoudXkPnFLV4k6BODozQhalYD6dvr%2bCXH24fO3%2bJVUOn%2fz69ug2Fwwg1jhFqAjbRXMt3iUiH1nosEBGRNqVU%2fcaNG5Hl9fEYZltXGxA%2fFrPVK8vDcTsmG7%2bZM2sALNsIN5R%2bSI%2b%2fZ5otsZtAvw%2b8hAkSq4DTBnYnCKrPUjpwoly7AN%2bLRCJPicg8z%2fNOFZF3y8rKVrqu69qYzUktJgcUM%2fRJxTuYxJYXcSmlyhlLqyvveiQvd%2fUBV7B0YPn%2f5nOoYOc2FHwgkU6nE8XFxYnKysrVqVRK2tra3KlTp2IDn6NwbMdk57y4o24fdxj9GkiHThAOx2T6MKn99O%2bRw%2bgJfl8SvBcBJ6TT6adEhO7u7syMGTP6Gis4lAEGoBuzvRsuZjFwQ%2fIc8HngZwR73QCtwCWYemxH6PP5kUikVGt90IGXzfAOt%2bIYdxiuiGbMmdASTHK7CuOOXZjN0pigXT2wVpC0RvuYdeMCT5Mn6mUFPI5ZAxMx0zaUoAmBiP3DFNAEXIoJDu8ET9bi74UEbBypJqT2egksia62sHcL0pEhtUlQnq0ieQVchDlRqMEcmdRhKtHyPESmB0IbC2GdcwSyH1gL0JRoQuOhsDs87f4ZdA%2bQFFEvZnSKh%2fefxF3HdmcwrjYk%2bqwdygNFwD3AV%2fO094DrgJ9nP8gNpYXipS2rcaSSlL%2fbsSTiaLT2dCoF%2bKfMvKjgfga4S0jEVcDd5HenesypwfaPI%2bCTQr5MfGRAcLC1MBezc%2fs%2bkB7ugME45cA5mFI7XxQUTPZ%2bGmgfylCSQ%2f4oTJ1z0iF47MeU3w8CmUJnIRhnJHArJlQ6Qwhwgd8IskKj9w4qIET%2bGIxvH1%2bgMTswJ8z3BYIGtVJojAnAzZiIFDnkCCZHPGpJ0Y31bXt33bdgPdUjF6Gkfz%2bUFVABrOagWuWQSAHPAPdi4ntXWEjQt2DuB04HrgTmM7x7CQ1q5Sljr1nx2t5HvFuObkak%2f%2bfZNdCFSTbDRRQ4D3MuWo%2fZ0TUtr493BsRHA7OBE4P%2fiz7CGK4Sq%2fmcv%2f7Qe%2bi089F6oMeFXWgeJqlN7FdONybRlGKuhwpBOngkEFjI%2bauHOYWLBOPEQuZ%2fTkn0wm63ve3eBT5KBk5euPP%2fYBbwMsyFwobgacTUMvfQfx00FCIU5t8hjqwFrg%2bEzMGsw4VAhSCrtN7fticJuw%2b0HPTj3Cg0ArOP3UF%2fVZjFncDyYRArFL2YauBJgJHOOErs0WpncktZxu%2bt8NEtvs6kF429lqVVd%2bUXMBhCwuLAnzDF2KeBW4Fbsi%2fDSY6FRoPJmEX4aeF4gvOj4WJQATn3A%2fMYeJuYRS%2bmTP4XQ1eouzAHYBvg4D0jJvtPBgbE%2bI8lIAQbk5lzo0kaE%2f8vBD6LqZ3yZdVOTNY9D%2bPr6%2fK0OYxBLjM%2bCQGCCaXhCz0XE5VuCwh2AP8g%2fyy0YCx%2fIPj7GmB9TptmYI8Su%2b80%2b2MLCC0kF3Pd8yVMcbUfeAiz8MKEtwEf5OmqAdgben8XU%2b0%2bD%2bzGXBZ%2bAfiLr93gzrJwFNQ6tB7KMHF6M7B34D0xEeDXgdAs%2fIDsvVmjhNpXY0qYTUDqo5blw72p7yB07Li8Ps6quh6uqy9GUGngVQ0X0D%2bz7YJuAOk77wkRDW8tPzIKEnAo60RVORErhq%2b9dUrsKIgjIL722l0%2fucVSDh2pDwoZatj4H%2bRdIAdHBVWZAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE1LTA5LTAyVDEyOjM5OjQ4LTA1OjAwppVa9QAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxNS0wOS0wMlQxMjozOTo0OC0wNTowMNfI4kkAAAAASUVORK5CYII%3d
                            format: base64 image
                            type: string
                          implements:
                            description: 'The service for which to implement authentication. The `implements` value is a string from the WHM API 1 `get_users_links` function. Typically, this function returns one of the following values:

                              * `billing` — This link appears in the user menu.

                              * `customer_service` — This link appears in the user menu.

                              * `support` — This link appears in the user menu.

                              * `upgrade` — This link appears in the user menu and context-sensitive areas when the user may require more of a resource.'
                            example: billing
                            type: string
                          label:
                            description: The label to display for the application on the cPanel *Home* interface.
                            example: WHMCS Billing
                            type: string
                          subscriber_unique_id:
                            description: The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.
                            example: '1234'
                            type: string
                          url:
                            description: 'A publicly-available URL to which to send the user if the

                              location in the `autologin_token_url` parameter does not

                              respond.'
                            example: http://www.example.com
                            format: url
                            type: string
                          user:
                            description: The cPanel account name.
                            example: username
                            format: username
                            type: string
                        type: object
                    type: object
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: get_integration_link_user_config
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
                        example: OK
                        type: string
                      result:
                        description: '* `1` - Success

                          * `0` - Failed: Check the reason field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Return integration link configuration
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  get_integration_link_user_config \\\n  user='username' \\\n  app='WHMCS_billing'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/get_integration_link_user_config?api.version=1&user=username&app=WHMCS_billing
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /list_integration_groups:
    get:
      description: This function lists the groups of integration links in the cPanel interface.
      operationId: Integration-list_integration_groups
      parameters:
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      links:
                        description: An array of objects that contain the integration link groups.
                        items:
                          properties:
                            group:
                              description: The group ID.
                              example: Group3
                              type: string
                          type: object
                        type: array
                    type: object
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: list_integration_groups
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
                        example: OK
                        type: string
                      result:
                        description: '* `1` — Success.

                          * `0` — Failed. Check the `reason` field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Return integration link groups
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  list_integration_groups \\\n  user='username'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/list_integration_groups?api.version=1&user=username
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /list_integration_links:
    get:
      description: This function lists integration links in the cPanel interface.
      operationId: Integration-list_integration_links
      parameters:
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      links:
                        description: An array of objects that contain information about the integration links.
                        items:
                          properties:
                            app:
                              description: The integration link's app name.
                              example: WHMCS_billing
                              type: string
                          type: object
                        type: array
                    type: object
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: list_integration_links
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
                        example: OK
                        type: string
                      result:
                        description: '* `1` - Success

                          * `0` - Failed. Check the reason field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Return integration links
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  list_integration_links \\\n  user='username'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/list_integration_links?api.version=1&user=username
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /remove_integration_group:
    get:
      description: This removes a group of integration links from the cPanel interface.
      operationId: Integration-remove_integration_group
      parameters:
      - description: The group's ID.
        in: query
        name: group_id
        required: true
        schema:
          example: WHMCS
          type: string
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: remove_integration_group
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
                        example: Ok
                        type: string
                      result:
                        description: '* `1` — Success.

                          * `0` — Failed. Check the `reason` field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Remove integration link group
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  remove_integration_group \\\n  user='username' \\\n  group_id='WHMCS'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_group?api.version=1&user=username&group_id=WHMCS
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /remove_integration_link:
    get:
      description: This function removes an integration link from the cPanel interface.
      operationId: Integration-remove_integration_link
      parameters:
      - description: The name of the integration link to remove.
        in: query
        name: app
        required: true
        schema:
          example: WHMCS_billing
          type: string
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          format: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: remove_integration_link
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
                        example: Ok
                        type: string
                      result:
                        description: '* `1` — Success.

                          * `0` — Failed. Check the `reason` field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Remove integration link
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  remove_integration_link \\\n  user='username' \\\n  app='WHMCS_billing'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_link?api.version=1&user=username&app=WHMCS_billing
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
  /update_integration_link_token:
    get:
      description: This function refreshes the token for an integration link.
      operationId: Integration-update_integration_link_token
      parameters:
      - description: "The name of the application to link.\n\n**Note:**\n\n To update the name of the application in the interface, you **must** delete it and then recreate it with WHM API 1's `create_integration_link` function."
        in: query
        name: app
        required: true
        schema:
          example: WHMCS_billing
          type: string
      - description: The new access token to use for the application.
        in: query
        name: token
        required: true
        schema:
          example: subway
          type: string
      - description: The cPanel account name.
        in: query
        name: user
        required: true
        schema:
          example: username
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data: {}
                  metadata:
                    properties:
                      command:
                        description: The method name called.
                        example: update_integration_link_token
                        type: string
                      reason:
                        description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
                        example: Ok
                        type: string
                      result:
                        description: '* `1` — Success.

                          * `0` — Failed. Check the `reason` field for more details.'
                        enum:
                        - 0
                        - 1
                        example: 1
                        type: integer
                      version:
                        description: The version of the API function.
                        example: 1
                        type: integer
                type: object
          description: HTTP Request was successful.
      summary: Update integration link token
      tags:
      - Integration
      x-codeSamples:
      - label: CLI
        lang: Shell
        source: "whmapi1 --output=jsonpretty \\\n  update_integration_link_token \\\n  user='username' \\\n  app='WHMCS_billing' \\\n  token='subway'\n"
      - label: URL
        lang: HTTP
        source: https://hostname.example.com:2087/cpsess##########/json-api/update_integration_link_token?api.version=1&user=username&app=WHMCS_billing&token=subway
      x-cpanel-api-version: WHM API 1
      x-cpanel-available-version: '54'
    servers:
    - description: A server running WHM.
      url: https://{host}:{port}/json-api
      variables:
        host:
          default: whm-server.tld
          description: The hostname of a server running WHM.
        port:
          default: '2087'
          description: The WHM port.
components:
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
externalDocs:
  url: https://cpanel.net/developers/
x-refined-from:
- cpanel-uapi-openapi.yml
- cpanel-whm-api-openapi.yml
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