Introduction to Service Actions

Service actions return data about the service and allow you to control the service.

You must add the ServicePort configuration parameter to the [Service] section of the configuration file to enable the service port. You can use authorization roles to control which users can send service control and service status actions. See Authorization Roles Configuration Parameters.

Service actions use the following syntax:

http://Host:Port/action=ActionName&[Parameters]

where,

Host The IP address or name of the machine hosting the service.
Port The ServicePort specified in the [Service] section of the configuration file.
ActionName One of the actions described in this section.
Parameters One or more parameters that might be required by an action. You must percent-encode all parameter values.

For example:

http://12.3.4.56:40010/action=GetConfig

This action uses port 40010 to request the service’s configuration file settings.