cPanel UAPI

components:
  schemas:
    Contents:
      properties:
        all_aliases_valid:
          description: 'Whether a valid SSL certificate exists on the domain''s aliases.


            * `1` — A valid SSL certificate exists.

            * `0` — A valid SSL certificate does **not** exist.


            **Note:**


            This return **only** appears if you set the `return_https_redirects_status` parameter to `1`.'
          enum:
          - 1
          - 0
          type: integer
        can_https_redirect:
          description: 'Whether a valid SSL certificate exists or AutoSSL runs on the domain.


            * `1` — A valid SSL certificate exists or AutoSSL runs.

            * `0` — A valid SSL certificate does **not** exist and AutoSSL does **not** run.


            **Note:**


            This return **only** appears if you set the `return_https_redirects_status` parameter to `1`.'
          enum:
          - 1
          - 0
          type: integer
        documentroot:
          description: The absolute path to the domain's document root.
          format: path
          type: string
        domain:
          description: The domain's name.
          format: domain
          type: string
        group:
          description: The domain's group.
          type: string
        hascgi:
          description: 'Whether CGI is enabled for the domain.


            * `1` — Enabled.

            * `0` — Disabled.'
          enum:
          - 1
          - 0
          type: integer
        homedir:
          description: The absolute path to the cPanel account's home directory.
          format: path
          type: string
        ip:
          description: The domain's IPv4 address.
          format: ipv4
          type: string
        ipv6:
          description: 'The domain''s IPv6 address.


            * null — The account does **not** use IPv6.'
          format: ipv6
          nullable: true
          type: string
        is_https_redirecting:
          description: 'Whether the domain redirects to `https`.


            * `1` — The domain redirects to `https`.

            * `0` — The domain does **not** redirect to `https`.


            **Note:**


            This return **only** appears if you set the `return_https_redirects_status` parameter to `1`.'
          enum:
          - 1
          - 0
          type: integer
        is_temporary:
          description: 'Whether the domain is a temporary domain.

            * `1` — The domain is temporary.

            * `0` — The domain is not temporary.'
          enum:
          - 1
          - 0
          type: integer
        no_cache_update:
          description: 'Whether the domain is subject to cache updates.


            * `1` — The domain updates caches.

            * `0` — The domain does **not** update caches.'
          enum:
          - 1
          - 0
          type: integer
        owner:
          description: The WHM account (`root` or a reseller) that owns the cPanel account.
          type: string
        serveradmin:
          description: The domain's administrator's contact email address.
          format: email
          type: string
        serveralias:
          description: A space-separated list of the domain's aliases.
          format: domain
          type: string
        servername:
          description: The domain's identifier on the server.
          format: domain
          type: string
        type:
          description: 'The type of domain:


            * `addon_domain` — The domain is an addon domain.

            * `sub_domain` — The domain is a subdomain.

            * `parked_domain` — The domain is a parked domain (domain alias).'
          enum:
          - addon_domain
          - sub_domain
          - parked_domains
          type: string
        usecanonicalname:
          description: 'The domain''s Canonical Name (CNAME) setting.


            * `On` — Use the domain''s CNAME.

            * `Off` — Do **not** use the domain''s CNAME.'
          enum:
          - 'On'
          - 'Off'
          type: string
        user:
          description: The cPanel account's username.
          format: username
          type: string
        userdirprotect:
          description: 'The domain''s [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak)

            setting.


            * `1` — Enabled.

            * `0` — Disabled.'
          enum:
          - 1
          - 0
          type: integer
    CreateUserResponse:
      allOf:
      - $ref: '#/components/schemas/SubaccountBase'
      - properties:
          dismissed_merge_candidates:
            description: An array of objects containing service candidates that the system dismissed from merges.
            items:
              $ref: '#/components/schemas/SubaccountBase'
            type: array
          has_expired_invite:
            description: 'Whether an expired account login invitation exists.

              * `1` - Expired account invitation exists.

              * `0` - Expired account invitation does **not** exist.'
            enum:
            - 0
            - 1
            example: 0
            type: integer
          has_invite:
            description: 'Whether an account login invitation exists.

              * `1` - Account invitation exists.

              * `0` - Account invitation does **not** exist.'
            enum:
            - 0
            - 1
            example: 0
            type: integer
          invite_expiration:
            description: When the invitation expires. A date in Unix time format.
            example: 1591718154
            format: unix_timestamp
            type: integer
          merge_candidates:
            description: 'An array of objects that represents the service accounts that the system could merge for

              this subaccount.'
            items:
              $ref: '#/components/schemas/SubaccountBase'
            type: array
        type: object
    EditUserSubaccountBase:
      properties:
        alternate_email:
          description: An alternate email address for the subaccount's user.
          example: user@example.com
          format: email
          type: string
        avatar_url:
          description: The user's subaccount profile photo.
          example: https://img.example.com/avatars/example.jpg
          format: url
          type: string
        can_delete:
          description: 'Whether the cPanel account user can delete the subaccount.


            * `1` - Can delete.

            * `0` - **Cannot** delete.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        can_set_password:
          description: "Whether the cPanel account user can change the subaccount's password.\n\n* `1` - Can change.\n* `0`\
            \ - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password\
            \ from the cPanel account."
          enum:
          - 0
          - 1
          example: 1
          type: integer
        can_set_quota:
          description: 'Whether the cPanel account user can change the subaccount''s disk usage quota.


            * `1` - Can change.

            * `0` - **Cannot** change.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        dismissed:
          description: "Whether the cPanel account user dismissed the merge prompt for the service account.\n\n**Note:**\n\
            \n  **Only** service accounts return this value.\n\n* `1` - Dismissed.\n* `0` - Did **not** dismiss."
          enum:
          - 0
          - 1
          example: 1
          type: integer
        domain:
          description: 'The Subaccount user''s associated domain.


            A domain that the cPanel account owns.'
          example: example.com
          format: domain
          type: string
        full_username:
          description: The subaccount's username and domain name.
          example: user@example.com
          type: string
        guid:
          description: The subaccount unique identifier.
          example: N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4
          type: string
        has_expired_invite:
          description: 'Whether an expired account login invitation exists.


            * `1` - Expired account invitation exists.

            * `0` - Expired account invitation does **not** exist.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        has_invite:
          description: 'Whether an account login invitation exists.


            * `1` - Account invitation exists.

            * `0` - Account invitation does **not** exist.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        has_siblings:
          description: 'Whether the service account shares a `full_username` value with another service account.


            * `1` - Shares.

            * `0` - Does **not** share.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        invite_expiration:
          description: When the invitation expires.
          example: 1591718154
          format: unix_timestamp
          type: integer
        issues:
          description: Information about any issues or problems with the subaccount.
          items:
            properties:
              area:
                description: The affected section of cPanel & WHM.
                example: quota
                type: string
              limit:
                description: The set quota megabyte (MB) limit for the affected subaccount.
                example: 1500
                type: integer
              message:
                description: The description of the issue.
                example: Your account is over quota.
                type: string
              service:
                description: 'The affected service.

                  * `email`

                  * `ftp`

                  * `webdisk`'
                enum:
                - email
                - ftp
                - webdisk
                example: email
                type: string
              type:
                description: 'The type of issue.

                  * `error`

                  * `warning`

                  * `info`'
                enum:
                - error
                - warning
                - info
                example: info
                type: string
              used:
                description: The number of megabytes (MB) that the account currently uses.
                example: 2000
                type: integer
            type: object
          type: array
        parent_type:
          description: 'The type of account that could own the service account.


            * `sub` - A subaccount.

            * `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of
            a merge.

            * `null`- **Not** a merge candidate.'
          example: hypothetical
          type: string
        phone_number:
          description: 'The subaccount user''s phone number.


            The number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)''s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended
            standard for the representation of telephone numbers.'
          example: '+15551234567'
          type: string
        real_name:
          description: 'The name of the subaccount''s user.


            * A first name, a last name, or a first name and last name.

            * An empty string.'
          example: John Doe
          type: string
        services:
          description: This object contains information about the subaccount's access to email, FTP, and Web Disk.
          properties:
            email:
              description: This object contains the information that indicates the subaccount's email status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access Webmail, POP, and IMAP services.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 1
                  type: integer
                quota:
                  description: "The maximum amount of disk space, in megabytes (MB), allocated to the subaccount's email account.\n\
                    \n**Note:**\n\n  This function will not return `0` as a value."
                  example: 100
                  type: integer
              type: object
            ftp:
              description: This object contains the information that indicates the subaccount's FTP status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access FTP.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
                homedir:
                  description: The subaccount's FTP home directory.
                  example: /subaccount
                  format: path
                  type: string
                quota:
                  description: 'The maximum amount disk space, in megabytes (MB), that the subaccount may use.


                    * A positive integer between `1` and `999999`

                    * `0` - Unlimited.'
                  example: 100
                  type: integer
              type: object
            webdisk:
              description: This object contains information that indicates the subaccount's Web Disk status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access Web Disk.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
                homedir:
                  description: The subaccount's Web Disk home directory.
                  example: /bob
                  format: path
                  type: string
                perms:
                  description: 'Whether to grant write permissions to the subaccount.


                    * `ro` - Read-only permissions.

                    * `rw` - Read and write permissions.'
                  enum:
                  - ro
                  - rw
                  example: rw
                  type: string
                private:
                  description: 'Whether to set the Web Disk directory''s permissions to public or private.


                    * `1` - Private (`0700`).

                    * `0` - Public (`0755`).'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
              type: object
          type: object
        special:
          description: 'Whether the account is a system-created special account that the user **cannot** remove.


            * `1` - A special account.

            * `0` - **Not** a special account.'
          enum:
          - 0
          - 1
          example: 1
          type: integer
        sub_account_exists:
          description: "Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\
            \n**Note:**\n\n  The function returns a `null` value if the account is **not** a service account."
          enum:
          - 0
          - 1
          example: 0
          type: integer
        synced_password:
          description: "Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n\
            * `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\n  The function returns a `null` value if\
            \ the account is **not** a subaccount."
          enum:
          - 0
          - 1
          example: 0
          type: integer
        type:
          description: 'The type of account.


            * `sub` - A subaccount.

            * `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of
            a merge.

            * `service` - A service account.

            * `cpanel` - The cPanel account.'
          example: sub
          type: string
        username:
          description: "The username for the subaccount.\n\n* Length - 64 characters.\n* Characters - `a-z`, `A-Z`, `0-9`,\
            \ dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\n  This value does **not** include the domain name."
          example: example
          type: string
      type: object
    FeatureDescriptions:
      properties:
        features:
          description: The list of features in a role.
          example:
          - Backup
          - MySQL® Databases
          - PHP
          items:
            type: string
          type: array
        id:
          description: The role's ID.
          example: database
          type: string
        title:
          description: The role's title.
          example: Database
          type: string
    HashOutput:
      properties:
        addon_domains:
          description: An array of objects containing information about each addon domain.
          items:
            $ref: '#/components/schemas/Contents'
        main_domain:
          description: An array of objects containing information about the main domain.
          items:
            $ref: '#/components/schemas/MainDomainContents'
        parked_domains:
          description: An array of objects containing information about each parked domain.
          items:
            $ref: '#/components/schemas/Contents'
        sub_domains:
          description: An array of objects containing information about each subdomain.
          items:
            $ref: '#/components/schemas/Contents'
      type: object
    ListOutput:
      anyOf:
      - $ref: '#/components/schemas/Contents'
      - $ref: '#/components/schemas/MainDomainContents'
    LookupServiceAccountSubaccountBase:
      properties:
        alternate_email:
          description: An alternate email address for the subaccount's user.
          example: user@example.com
          format: email
          type: string
        avatar_url:
          description: The user's subaccount profile photo.
          example: https://img.example.com/avatars/example.jpg
          format: url
          type: string
        can_delete:
          description: 'Whether the cPanel account user can delete the subaccount.


            * `1` - Can delete.

            * `0` - **Cannot** delete.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        can_set_password:
          description: "Whether the cPanel account user can change the subaccount's password.\n\n* `1` - Can change.\n* `0`\
            \ - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password\
            \ from the cPanel account."
          enum:
          - 0
          - 1
          example: 1
          type: integer
        can_set_quota:
          description: 'Whether the cPanel account user can change the subaccount''s disk usage quota.


            * `1` - Can change.

            * `0` - **Cannot** change.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        dismissed:
          description: "Whether the cPanel account user dismissed the merge prompt for the service account.\n\n**Note:**\n\
            \n  **Only** service accounts return this value.\n\n* `1` - Dismissed.\n* `0` - Did **not** dismiss."
          enum:
          - 0
          - 1
          example: 1
          type: integer
        domain:
          description: 'The Subaccount user''s associated domain.


            A domain that the cPanel account owns.'
          example: example.com
          format: domain
          type: string
        full_username:
          description: The subaccount's username and domain name.
          example: user@example.com
          type: string
        guid:
          description: The subaccount unique identifier.
          example: N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4
          type: string
        has_expired_invite:
          description: 'Whether an expired account login invitation exists.


            * `1` - Expired account invitation exists.

            * `0` - Expired account invitation does **not** exist.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        has_invite:
          description: 'Whether an account login invitation exists.


            * `1` - Account invitation exists.

            * `0` - Account invitation does **not** exist.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        has_siblings:
          description: 'Whether the service account shares a `full_username` value with another service account.


            * `1` - Shares.

            * `0` - Does **not** share.'
          enum:
          - 0
          - 1
          example: 0
          type: integer
        invite_expiration:
          description: When the invitation expires.
          example: 1591718154
          format: unix_timestamp
          type: integer
        issues:
          description: Information about any issues or problems with the subaccount.
          items:
            properties:
              area:
                description: The affected section of cPanel & WHM.
                example: quota
                type: string
              limit:
                description: The set quota megabyte (MB) limit for the affected subaccount.
                example: 1500
                type: integer
              message:
                description: The description of the issue.
                example: Your account is over quota.
                type: string
              service:
                description: 'The affected service.

                  * `email`

                  * `ftp`

                  * `webdisk`'
                enum:
                - email
                - ftp
                - webdisk
                example: email
                type: string
              type:
                description: 'The type of issue.

                  * `error`

                  * `warning`

                  * `info`'
                enum:
                - error
                - warning
                - info
                example: info
                type: string
              used:
                description: The number of megabytes (MB) that the account currently uses.
                example: 2000
                type: integer
            type: object
          type: array
        parent_type:
          description: 'The type of account that could own the service account.


            * `sub` - A subaccount.

            * `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of
            a merge.

            * `null`- **Not** a merge candidate.'
          example: hypothetical
          type: string
        phone_number:
          description: 'The subaccount user''s phone number.


            The number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)''s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended
            standard for the representation of telephone numbers.'
          example: '+15551234567'
          type: string
        real_name:
          description: 'The name of the subaccount''s user.


            * A first name, a last name, or a first name and last name.

            * An empty string.'
          example: John Doe
          type: string
        services:
          description: This object contains information about the subaccount's access to email, FTP, and Web Disk.
          properties:
            email:
              description: This object contains the information that indicates the subaccount's email status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access Webmail, POP, and IMAP services.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 1
                  type: integer
                quota:
                  description: "The maximum amount of disk space, in megabytes (MB), allocated to the subaccount's email account.\n\
                    \n**Note:**\n\n  This function will not return `0` as a value."
                  example: 100
                  type: integer
              type: object
            ftp:
              description: This object contains the information that indicates the subaccount's FTP status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access FTP.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
                homedir:
                  description: The subaccount's FTP home directory.
                  example: /subaccount
                  format: path
                  type: string
                quota:
                  description: 'The maximum amount disk space, in megabytes (MB), that the subaccount may use.


                    * A positive integer between `1` and `999999`

                    * `0` - Unlimited.'
                  example: 100
                  type: integer
              type: object
            webdisk:
              description: This object contains information that indicates the subaccount's Web Disk status.
              properties:
                enabled:
                  description: 'Whether the subaccount can access Web Disk.


                    * `1` - Can access.

                    * `0` - **Cannot** access.'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
                homedir:
                  description: The subaccount's Web Disk home directory.
                  example: /bob
                  format: path
                  type: string
                perms:
                  description: 'Whether to grant write permissions to the subaccount.


                    * `ro` - Read-only permissions.

                    * `rw` - Read and write permissions.'
                  enum:
                  - ro
                  - rw
                  example: rw
                  type: string
                private:
                  description: 'Whether to set the Web Disk directory''s permissions to public or private.


                    * `1` - Private (`0700`).

                    * `0` - Public (`0755`).'
                  enum:
                  - 0
                  - 1
                  example: 0
                  type: integer
              type: object
          type: object
        special:
          description: 'Whether the account is a system-created special account that the user **cannot** remove.


            * `1` - A special account.

            * `0` - **Not** a special account.'
          enum:
          - 0
          - 1
          example: 1
          type: integer
        sub_account_exists:
          description: "Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\
            \n**Note:**\n\n  The function returns a `null` value if the account is **not** a service account."
          enum:
          - 0
          - 1
          example: 0
          type: integer
        synced_password:
          description: "Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n\
            * `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\n  The function returns a `null` value if\
            \ the account is **not** a subaccount."
          enum:
          - 0
          - 1
          example: 0
          type: integer
        type:
          description: 'The type of account.


            * `sub` - A subaccount.

            * `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of
            a merge.

            * `service` - A service account.

            * `cpanel` - The cPanel account.'
          example: sub
          type: string
        username:
          description: "The username for the subaccount.\n\n* Length - 64 characters.\n* Characters - `a-z`, `A-Z`, `0-9`,\
            \ dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\n  This value does **not** include the domain name."
          example: example
          type: string
      type: object
    LookupServiceAccountSubaccountMergeCandidates:
      properties:
        merge_candidates:
          description: An array of objects that represents the service accounts that the system could merge for this subaccount.
          items:
            allOf:
            - $ref: '#/components/schemas/LookupServiceAccountSubaccountBase'
            - $ref: '#/components/schemas/LookupServiceAccountSubaccountMergeCandidatesEmpty'
          type: array
      type: object
    LookupServiceAccountSubaccountMergeCandidatesEmpty:
      properties:
        merge_candidates:
          description: An array of objects that represents the service accounts that the system could merge for this subaccount.
          items:
            type: object
          type: array
      type: object
    MainDomainContents:
      properties:
        all_aliases_valid:
          description: 'Whether a valid SSL certificate exists on the domain''s aliases.


            * `1` — A valid SSL certificate exists.

            * `0` — A valid SSL certificate does **not** exist.


            **Note:**


            This return **only** appears if you set the `return_https_redirects_status` parameter to `1`.'
          enum:
          - 1
          - 0
          type: integer
        can_https_redirect:
          description: 'Whether a valid SSL certificate exists or AutoSSL runs on the domain.


            * `1` — A valid SSL certificate exists or AutoSSL runs.

            * `0` — A valid SSL certificate does **not** exist and AutoSSL does **not** run.


            **Note:**


            This return **only** appears if you set the `return_https_redirects_status` parameter to `1`.'
          enum:
          - 1
          - 0
          type: integer
        customlog:
          description: 'The domain''s [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html)

            information.'
          properties:
            format:
              description: 'The [log file](https://httpd.apache.org/docs/2.2/mod/mod_log_config.html#logformat)''s

                format.'
              type: string
            target:
              description: The absolute path to the domain's log file in the `domlogs` directory.
              type: string
          type: object
        documentroot:
          description: The absolute path to the domain's document root.
          format: path
          type: string
        domain:
          description: The domain's name.
          format: domain
          type: string
        group:
          description: The domain's group.
          type: string
        hascgi:
          description: 'Whether CGI is enabled for the domain.


            * `1` — Enabled.

            * `0` — Disabled.'
          enum:
          - 1
          - 0
          type: integer
        homedir:
          description: The absolute path to the cPanel account's home directory.
          format: path
          type: string
        ifmodulemodsuphpc:
          description: Information about PHP scripts and suPHP.
          properties:
            group:
              description: If suPHP is enabled, PHP scripts run as this group.
              type: string
          type: object
    

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