Child pages
  • Guide to API Authentication - Browser-Based Authentication
Skip to end of metadata
Go to start of metadata

 

Introduction

Browser-based authentication accesses cPanel & WHM's functionality via the browser.

Important:

  • API calls that use a method that includes a URL must use the correct port:
    • 2082 — Unsecure calls to cPanel's APIs.
    • 2083 — Secure calls to cPanel's APIs.
    • 2086 — Unsecure calls to WHM's APIs, or to cPanel's APIs via the WHM API.
    • 2087 — Secure calls to WHM's APIs, or to cPanel's APIs via the WHM API.
    • 2095 — Unsecure calls to cPanel's APIs via a Webmail session.
    • 2096 — Secure calls to cPanel's APIs via a Webmail session.
    Otherwise-correct calls will return Permission denied or Function not found errors if they use an incorrect port number. 
  • This document only includes cPanel & WHM authentication methods. For Manage2 authentication information, read our Guide to the Manage2 API documentation.

Browser-based authentication

To call API functions through a web browser, you must first log in to WHM or cPanel.

  • The API function determines which cPanel, Inc. product to log in to.
  • Some functions require specific feature lists or user permissions.

For help to log in to WHM or cPanel, read our How to Access cPanel & WHM Services documentation.

Examples

For more information and examples of browser-based calls, read the documentation for the function's API:

  • Guide to cPanel API 2 — cPanel API 2 accesses cPanel account information and modifies settings.
  • Guide to UAPI — UAPI accesses the cPanel interface's features.

  • Guide to WHM API 1 — WHM API 1 accesses the WHM interface's features.

    Note:

    You can call cPanel API2 and UAPI functions through the WHM API. This is useful, for example, when you develop plugins for WHM users, particularly resellers, but need to access cPanel functions. For more information, read our Use WHM API to Call cPanel API and UAPI documentation.