Sign in
Server Actions

Create server action

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 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

Changed in 4 of the 115 revisions of this API.48

  • 05f4250e90c72See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 02a14829a49c2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 30e75dc6a94c4See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • c6aaf3632e484See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog