Syslog Agents

GET syslog_notification_agents

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of Syslog Agents configuration.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/.format

Example Request

GET

http://44.235.52.211/api/2.0/syslog_notification_agents/.json

[
    {
        "SyslogNotificationAgent": {
            "id": 1,
            "title": "Default",
            "ip_address": "192.168.0.100",
            "port": 514,
            "tcp": 0,
            "network_id": 0,
            "keep_alive_interval": null,
            "send_clear_notification": 1,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    },
    {
        "SyslogNotificationAgent": {
            "id": 2,
            "title": "test_Syslog",
            "ip_address": "192.168.1.1",
            "port": 2000,
            "tcp": 0,
            "network_id": 0,
            "keep_alive_interval": null,
            "send_clear_notification": 1,
            "modified": "1619960140691",
            "created": "1619960140691"
        }
    }
]

GET syslog_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single Syslog Agent configuration data.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Syslog Agent to be viewed.

Example Request

GET

http://44.235.52.211/api/2.0/syslog_notification_agents/1/.json

{
    "SyslogNotificationAgent": {
        "id": 1,
        "title": "Default",
        "ip_address": "192.168.0.100",
        "port": 514,
        "tcp": 0,
        "network_id": 0,
        "keep_alive_interval": null,
        "send_clear_notification": 1,
        "modified": "1611142282208",
        "created": "1611142282208"
    }
}

POST syslog_notification_agents

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new Syslog Agent.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/.format

Example Request

POST

http://44.235.52.211/api/2.0/syslog_notification_agents/.json

{
    "SyslogNotificationAgent": {
        "ip_address": "192.168.0.84",
        "keep_alive_interval": "",
        "network_id": "0",
        "port": "564",
        "send_clear_notification": "0",
        "title": "syslogAgent3"
    }
}

POST syslog_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Duplicates a specific Syslog Agent into a new one, resulting with an identical agent's data except for the title.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Syslog Agent to be copied.

Example Request

POST

http://44.235.52.211/api/2.0/syslog_notification_agents/3/.json

PUT syslog_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates a specific Syslog Agent data.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
1 (required)	integer	The ID of the desired Syslog Agent to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/syslog_notification_agents/3/.json

DELETE syslog_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a specific Syslog Agent

Resource URL

http://{host}/api/2.0/syslog_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Syslog Agent to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/syslog_notification_agents/3/.json

GET syslog_notification_agents/command/test/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Sends test Syslog notification for an existing agent.

Resource URL

http://{host}/api/2.0/syslog_notification_agents/command/test/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired agent to send Syslog notification.

Example Request

GET

http://44.235.52.211/api/2.0/syslog_notification_agents/command/test/1/.json