The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
This function retrieves the news of a specified type.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=News&cpanel_jsonapi_func=get_news&type=globalFor more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve the server news.
$extra_extra = $cpanel->api2(
'News', 'get_news',
array(
'type' => 'global',
)
);For more information, read our Guide to the LiveAPI System.
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve the server news.
my $extra_extra = $cpliveapi->api2(
'News', 'get_news',
{
'type' = 'global',
}
);For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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.
- 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 documentation.
Command Line
cpapi2 --user=username News get_news type=global- You must URI-encode values.
usernamerepresents your account-level username.- You must include the
--user=usernameoption. - For more information and additional output options, read our Guide to cPanel API 2 documentation or run the
cpapi2 --helpcommand. - If you run CloudLinux™, you must use the full path of the
cpapi2command:syntaxhighlighter-pre/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"data": [
"The network skeleton says good night."
],
"func": "get_news",
"event": {
"result": 1
},
"module": "News"
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
type | string | Required The type of news. |
| global |
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
data | string | The server news. | Text in string format. | The network skeleton says good night. |
reason | string | A reason for failure. Note: This function only returns a value if it failed. | A string that describes the error. | This is an error message. |
result | Boolean | Whether the function succeeded. |
| 1 |