| home > API > [/event/begin] > |
| request url |
https://[SERVER]:[PORT]/event/begin[?PARAMETER1=value[&...]] |
| short description |
Starts an event. |
| long description |
Request an exclusive lock. The function will wait until a lock is
acquired. If the lock is aquired, the whole server will block any
request for any other session. |
| parameters |
| name |
type |
description |
| sid |
string |
Session identifier for a server connection. A
supervision server has to use his session identifier here which is
communicated by Palo to a supervision server during startup. A
supervision must not use login to obtain a session identifier. |
| source |
string |
Session identifier used for logging during the
event. All requests between the "event/begin" and "event/end" are
logged with the user of the source session instead of the user of the
current session denoted by the "sid" parameter. A supervision server
has to fill the source parameter with the session identfier which
triggered the supervision server. |
| event |
string |
String used for logging during the event. All
requests between the "event/begin" and "event/end" are logged with
this string as event. A supervision server has to fill the event
parameter with the area identifier which triggered the supervision
server. |
|
| result |
| # |
name |
type |
description |
| 0 |
OK |
integer |
"1" means OK |
|
| examples |
|
| further information |
|