NEnetxms
Server Actions

Create server action

Changed on

Create a new server action. Only the name field is required. Additional fields (type, data, etc.) can optionally be included to configure the action immediately after creation.

post/v1/server-actions

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/server-actions
  • Auth
    HTTP bearer

Request body

namestring required

Action name

typeinteger

Action type

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)

datastring

Action data (command, message, or script name depending on type)

recipientAddressstring

Recipient address

emailSubjectstring

Email subject

notificationChannelNamestring

Notification channel name

Response

Server action created 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

  • 05f4250e90c7Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 02a14829a49cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status