NEnetxms
Server Actions

Get server action details

Changed on

Retrieve details of a specific server action by its ID.

get/v1/server-actions/{action-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/server-actions/{action-id}
  • Auth
    HTTP bearer

Path parameters

action-idinteger required

Action ID

Response

Server action retrieved successfully

idinteger

Action ID

guidstring uuid

Action GUID

namestring

Action name

typeinteger

Action type: 0=execute command on server, 1=execute command on remote node via agent, 3=send notification, 4=forward event, 5=execute server-side script, 7=execute command via SSH

typeDescriptionstring

Human-readable action type description

isDisabledboolean

Whether the action is disabled

isMarkdownboolean

Whether the notification message body is markdown

sendGeoLocationboolean

Whether the source object's geolocation is sent along with the notification (only for channels supporting location messages)

recipientAddressstring

Recipient address (supports macros)

emailSubjectstring

Email subject (supports macros)

notificationChannelNamestring

Notification channel name

commandstring

Action payload for command-type actions (type 0, 1, or 7). Exactly one of command/message/scriptName/data is present, selected by the action type.

messagestring

Action payload for notification actions (type 3).

scriptNamestring

Action payload for script actions (type 5).

datastring

Action payload for other action types (e.g. type 4, forward event).

Changes