cPanel API 2 Functions - News::get_news - Knowledgebase

Description

This function retrieves the news of a specified type.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

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=global

 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',
    ) 
);

 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',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
 "cpanelresult": {
    "apiversion": 2,
    "data": [
      "The network skeleton says good night."
    ],
    "func": "get_news",
    "event": {
      "result": 1
    },
    "module": "News"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
type	string	Required The type of news.	global local resold	global

Parameter

Type

Description

Possible values

Example

type

string

Required

The type of news.

global
local
resold

global

Returns

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 areason value if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories