api-object-access

Global System Log

You can configure the integration settings with communication with Syslog servers for Mojo to communicate and send log messages to Syslog servers.
If Syslog integration is enabled, the system sends messages to the configured Syslog servers. Otherwise, Syslog integration services are shut off. Apart from events, you can also send audit logs from Mojo to a Syslog server.

JSON Table

Attribute Data Type Description
policyCreatedAtLocId application/json The location ID where policy was created. The value is of the type Location ID JSON.
policyType String A read-only field for internal use.
integrationEnabled boolean A true or false value indicating whether the syslog server integration
is enabled or disabled.
syslogServers application/json
syslogServers/enabled boolean A true or false value indicating whether to Enable or Disable sending
events and/or audit logs to this Syslog server.
syslogServers/ipAddress String Syslog Server IP Address or Hostname.
syslogServers/trapPort int Port number of the Syslog server to which the system sends events.
syslogServers/appendBOMHeader boolean A true or false value indicating whether to append the byte order mark
to the syslog server entry or not.
syslogServers/forwardEvents boolean A true or false value indicating whether to send events to the Syslog
server or not. A true value sends events to the Syslog server.
syslogServers/forwardAuditLogs boolean A true or false value indicating whether to send audit logs to the Syslog
server or not. A true value sends audit logs to the Syslog server.
syslogServers/forwardSubEvents boolean A true or false value indicating whether to send sub-events to the Syslog
server. A true value sends sub-events to the Syslog server.
syslogServers/ciepMacaddress
syslogServers/ciepName
syslogServers/messageFormat enum Format in which the event is sent. Applicable values are:

  • PLAIN
  • IDMEF (Intrusion Detection Message Exchange Format)

Forward Sub Events and Forward Audit Logs are not available in case you select IDMEF message format.

Copy Sample JSON
Sample JSON 
{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "SYSLOG_POLICY",
	"integrationEnabled": false,
	"syslogServers": [{
		"enabled": false,
		"ipAddress": null,
		"trapPort": 0,
		"appendBOMHeader": false,
		"forwardEvents": true,
		"forwardAuditLogs": false,
		"forwardSubEvents": false,
		"ciepMacaddress": null,
		"ciepName": null,
		"messageFormat": null
	}]
}
API Calls
Get

/V5/configuration/global/syslog

Put

/V5/configuration/global/syslog

Get Global System Log

Description The API is used to retrieve syslog configuration details.
Syntax
GET /configuration/global/syslog?nodeid=<value>isdefault=<value>

Here,

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.

  • isdefault

    When we pass this parameter as true then system default configuration for that location is return else whatever user has defined is returned. It takes a boolean value. The default value is false.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/configuration/global/syslog?nodeid=0&isdefault=false
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the syslog configuration. The response is in the application/json format.

Save Global System Log

Description The API is used to save syslog configuration details.
Syntax
PUT <Base_URL>/configuration/global/syslog?nodeid=<value>

Here,

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/configuration/global/syslog?nodeid=0
Request Body The API call requires the details of the syslog plicy and syslog server for configurations, which are passed as parameters in the request body. The parameters are passed in the application/json format.

A sample request body is as follows:

{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "SYSLOG_POLICY",
	"integrationEnabled": false,
	"syslogServers": [{
		"enabled": false,
		"ipAddress": null,
		"trapPort": 0,
		"appendBOMHeader": false,
		"forwardEvents": true,
		"forwardAuditLogs": false,
		"forwardSubEvents": false,
		"ciepMacaddress": null,
		"ciepName": null,
		"messageFormat": null
	}]
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the saved details of the syslog configuration. The response is in the application/json format.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.