---
title: "Return active cPanel sessions"
method: GET
path: "/ActiveSessions/list_active_sessions"
tags: ["ActiveSessions"]
---

# Return active cPanel sessions

`GET /ActiveSessions/list_active_sessions`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/ActiveSessions/list_active_sessions`
- Auth: HTTP basic

This function returns the active cPanel sessions for the current user,
so the account owner can review where their account is currently signed
in and spot a session they do not recognize.

**Note:**

* This function returns an array, so UAPI's generic `api.filter_*`,
  `api.sort_*` and `api.paginate_*` parameters apply, and a
  caller-supplied sort replaces the default ordering of the `data`
  return value.
* Session addresses are private, so this function is unavailable to demo
  (shared) accounts.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The name of the method called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` object[]: The current user's active sessions, current session first, then the rest by most recently active. **Note:** Empty when the user has no unexpired sessions, and also when the function cannot read the session store.
      - `ip_address` string: Remote address the session connects from. Empty when the session recorded none.
      - `is_current` 1 | 0: Whether this is the session that made this request. * `1` - This is the current session. * `0` - It is another session.
      - `is_possessed` 1 | 0: Whether an operator, such as the account's reseller or root, is acting as the user through this session. * `1` - The session is being operated on the user's behalf. * `0` - The user signed in directly.
      - `last_active` integer: Unix timestamp of the session's last activity, taken from the session file's modification time.
      - `login_theme` string: The interface the session logged in to, for example `cpanel` or `webmail`.
      - `tfa_verified` 1 | 0: Whether two-factor authentication was completed for this session. * `1` - Two-factor authentication was completed. * `0` - It was not.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `status` 0 | 1: * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

## Changes

- **2026-09-12** `99adb57e7a5d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/ActiveSessions/list_active_sessions/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)