systemstatus_get_cns_status

This API returns the name and status of the CNS Server(s).

Concept Link IconSee Also

Parameters:

Argument

Required

Type

Description

Online no boolean This is set to false by default. If online is false, the call gets data cached in the database. When it is set to 1, it gets the real time state.

page

no

string

The page to display if a per_page argument is provided.

per_page

no

string

The number of listed entries to display per page.

format

no

string

The format of the output for the API: text, json or xml. The default is text.

callback

no

string

This only works with Direct APIs. This is a JavaScript function that should be called after the API is completed. This function will be called with the response of the API.  Please note: It can only be used when requesting this API via AJAX request. More Information can be found here.

Example:

servername/webadmin/api/systemstatus_get_cns_status.php?

Output:

OK:

name=>localhost

status=>Online

name=>asdf

status=>Offline

ERROR: Permission Denied: Unauthorized access.

 

Netsweeper Version: 3.1.0