Settings - Web API
  • 28 Aug 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Settings - Web API

  • Dark
    Light
  • PDF

Article summary

  • Enable Web API - Enables the Web API of Composer.
  • Web API listening port - Port for HTTP API (not HTTPS, which is served on 443)
  • Web API Https FQDN - Fully qualified domain name for the workstation/server running Composer. This is required for HTTPS. For more information on HTTPS, see a later chapter dedicated to HTTPS.
  • Disable Web API when the project is not running - If the project is not running, the Web API will be disabled, for example, during startup, auto restart, etc. This is to prevent errors.
Note!
The application needs to be run with elevated permissions (Administrator) for the HTTP(S) API:s to operate. Changing the configuration requires an application restart.

Was this article helpful?