Authentication

Create AUTH-session

Use this endpoint to create an authentication session for managing your KVM VPS. Simply provide your WHMCS credentials (email and password) to authenticate requests. Optionally, you can specify a kvm_id to limit the session access to a specific KVM instance

post/kvm/v2/get/auth

Request

Request body application/x-www-form-urlencoded

emailstring

Your WHMCS account email address used for login. This is the same email you use to sign in to your WHMCS client area.

pwstring

Your WHMCS account password.

⚠️ Important: If your password contains special characters (such as +, &, =), the default cURL snippet using --data may not work correctly.

✅ To avoid issues:

  • Use --data-urlencode "pw=your-password", or
  • URL-encode your password manually before using it with the --data flag.

🔧 You can encode your password using this online tool.

Example: your-password

kvm_idstring

(Optional) The unique identifier of the KVM to filter the session.
If not provided, the session applies to all KVMs associated with your account.

Example request

{
  "email": "your-email@example.com"
}

Response

Authentication session created successfully.

paymentmethodsstring[]

A list of available payment methods.

statusstring

Example response

{
  "paymentmethods": [
    "paypal",
    "alipay",
    "creditcard",
    "cryptomus"
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.