latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Session

Create login link for Dashboard

This function creates a single-use WHM session for re-entry from WebPros Dashboard.

get/wp_dashboard_create_login_link

Query parameters

service'cpaneld' | 'whostmgrd' | 'webmaild'
Example:whostmgrd

The session's service.

userstring
Example:username@example.com

The session's cPanel account username or a valid email address.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "cp_security_token": "/cpsess1234567890",
    "expires": 1401993893,
    "service": "whostmgrd",
    "session": "username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa",
    "url": "https://hostname.example.com:2087/cpsess1234567890/login/?session=username:RFw6MUp9S8sRwTSgqaUJWUCq8ZQg2Zkopx5KaTHRNQXBfT3n8xvfBEF9JJC3iiwa"
  },
  "metadata": {
    "command": "wp_dashboard_create_login_link",
    "reason": "Created session",
    "result": 1,
    "version": 1
  }
}