Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Web API Settings

The Web API service is an HTTP endpoint that lets you trigger the execution of a project remotely.

Installation

The appRules.WebApiService service is installed automatically by appRulesSetup.exe. If it wasn't created, you can install it manually by running install_webapi_service.cmd as administrator, located in appRulesPortal\Startup\Services Installation.

Configuration

The HTTP address and port are set in appRules.WebApiService.appsettings.json, found in [Install_path]\appRulesPortal\bin.

You can also define an ApiKey in the same file. When one is set, the service will only run a project if the caller supplies the matching key (Mandatory if the Web Api address is public).

Run in background mode

For workflows using Run in background, the list of available Web API servers is declared in Admin Center → Deployment Settings → Web API server definitions.

For details on calling the service, see Using Web Api.

Last updated