Execute REST Command Action

Representational State Transfer (REST) is a software architecture style consisting of guidelines and best practices for creating scalable web services. The Execute REST Command action performs actions on these web services.

NOTE: It is recommended that the web service to be monitored is running or available for view so that the parameter details can be copied accurately into the parameters of the REST Command action.
NOTE: If a table value has previously been saved as a variable within the separate Web Application Monitor, this can be called as one of the parameters for a REST Command Action.
Address

Enter the address of the web server on which the service is running.

EXAMPLE: https://devcms:444/
Command

Enter the command to be performed on the web service.

EXAMPLE: killthread
Parameters

Use the Add button to enter the parameter key and value settings for each part of the command, building up the full address of the web service.

EXAMPLE:
Key Value
addr DEVCMS
&port 4269
&p1 13362
Request Method

Select the request method that defines what to do with the data identified by the Address, Command and Parameter fields.

  • GET: GET is the simplest type of HTTP request method. It instructs the server to transmit the data identified by the URL to the client
  • POST: POST is used when the processing on the server needs to be repeated if the POST request is repeated. Additionally, POST requests should cause processing of the request body as a subordinate of the URL to which the post is being made
  • PUT: A PUT request is used to create or update the resource identified by the URL
  • DELETE: DELETE performs the opposite of PUT and should be used to delete the resource identified by the URL of the request
Authentication

Specify whether the web server requires authentication in order for the command to be run. If authentication is required, select the Basic Authentication option and enter a User Name and valid Password for this server.

Rest Command Example

As details are entered into the fields in this dialog, an example of how the final command will look is displayed in this field.

Substitution Variables

Use the available substitution variables to build further identifiers and commands into the REST Command action.

Once completed click OK to add the REST Command action to the rule.

Related Topics