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.

When the service port is enabled, it accepts the following standard status and control actions:

ACIThreadStatus Returns the status of the service threads.
CancelACIAction Cancels an ACI action.
Diagnostic Creates a ZIP file that contains information useful for troubleshooting.
GetConfig Returns the service configuration file settings.
GetLogStream Returns a specific log stream for the service.
GetLogStreamNames Returns the names of the log streams that have been set up for the service.
GetStatistics Returns statistics for the service.
GetStatus Returns the service status (running or stopped).
GetStatusInfo Returns status information for the service (for example, the service product name and version number).
Stop Stops the service.
ValidateConfig Returns a list of any configuration errors such as repeated or unused configuration keys and sections.