# cPanel API 2 Functions - LVEInfo::getUsage

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](https://api.docs.cpanel.net/cpanel/introduction) instead of cPanel API 2.

## Description

This function returns a CloudLinux™ system account's [LVE](https://docs.cpanel.net/whm/server-configuration/cloudlinux-manager/) information.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=LVEInfo&cpanel_jsonapi_func=getUsage
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Get LVE usage on example.com.
$get_lve_usage = $cpanel->api2(
    'LVEInfo', 'getUsage'

);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Get LVE usage on example.com.
my $get_lve_usage = $cpliveapi->api2(
    'LVEInfo', 'getUsage',
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username LVEInfo getUsage
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** run the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
    "cpanelresult": {
        "data": [{
            "From": "04-18 13:24",
            "To": "04-18 13:25",
            "ID": "user",
            "aCPU": "2.0G",
            "mCPU": "28",
            "lCPU": "100",
            "aEP": "7",
            "mEP": "15",
            "lEP": "20",
            "aVMem": "2147",
            "mVMem": "2147483",
            "lVMem": "2147483648",
            "VMemF": "1",
            "EPf": "1"
        }],
        "module": "LVEInfo",
        "func": "getUsage",
        "apiversion": 2,
        "event": {
            "result": 1
        }
    }
}
```

Note:
Use cPanel's [*API Shell*](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel) interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
from
td
em
string
td
The LVE information sample period's start time.
td
p
The date and time in 
code
MM-DD-HH:mm
 format, where:
ul
li
code
MM
 represents the month.
li
code
DD
 represents the date.
li
code
HH
 represents the hour.
li
code
mm
 represents the minute.
td
code
04-17 13:24
tr
td
code
to
td
em
integer
td
The LVE information sample period's finish time.
td
p
The date and time in 
code
MM-DD-HH:mm
 format, where:
ul
li
code
MM
 represents the month.
li
code
DD
 represents the date.
li
code
HH
 represents the hour.
li
code
mm
 represents the minute.
td
code
04-18 13:25
tr
td
code
ID
td
em
string
td
The account's username.
td
Any valid username.
td
code
user
tr
td
code
                 aCPU
td
em
integer
td
The account's average CPU usage.
td
p
An integer with any of the following symbols:
ul
li
code
G
 — gigabytes
li
code
M
 — megabytes
li
code
K
 — kilobytes
td
code
2.0G
tr
td
code
mCPU
td
em
string
td
The account's maximum CPU usage percentage.
td
A positive integer.
td
code
28
tr
td
code
lCPU
td
em
integer
td
The account's CPU usage limit percentage.
td
A positive integer.
td
code
100
tr
td
code
aEP
td
em
integer
td
The number of the account's Entry Processes.
td
A positive integer.
td
code
7
tr
td
code
mEP
td
em
integer
td
The account's maximum number of Entry Processes.
td
A positive integer.
td
code
15
tr
td
code
lEP
td
em
integer
td
The account's Entry Process limit.
td
A positive integer.
td
code
20
tr
td
code
aVMem
td
em
integer
td
The account's average virtual memory usage limit, in bytes.
td
A positive integer.
td
code
2147
tr
td
code
mVmem
td
em
integer
td
The account's maximum level of virtual memory, in bytes.
td
A positive integer.
td
code
2147483
tr
td
code
lVMem
td
em
integer
td
The account's virtual memory usage limit, in bytes.
td
A positive integer.
td
code
2147483648
tr
td
code
mpcpu
td
em
integer
td
The package's maximum CPU usage percentage.
td
A positive integer.
td
code
28
tr
td
code
VMemF
td
em
integer
td
The number of the account's 
code
Out of Memory
 errors.
td
A positive integer
td
code
1
tr
td
code
EPf
td
em
integer
td
The number of the account's Entry Process errors.
td
A positive integer.
td
code
1
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1