Skip to main content

API and web settings

These values derive URLs and guide API/web integration. They do not by themselves deploy a gateway, configure authentication or prove TLS binding.

UI purpose / propertyType/defaultVerified use and limitation
API domain / VeloxAPIDomainhost / localhostUsed to derive VeloxAPIUrl
API port / VeloxAPIPortinteger / 8359API Service listener port; service also falls back to 8359 when stored value is 0
Enable API SSL / VeloxAPIEnableSSLBoolean / trueChanges derived URL scheme. Reviewed API listener startup did not bind this flag to TLS.
API certificate / VeloxAPICertificatepath / emptyStored certificate reference; reviewed listener startup did not load/bind it
API URL / VeloxAPIUrlderived read-onlyhttps://localhost:8359 with defaults
Web domain / VeloxWebDomainhost / local FQDNUsed to derive web URL
Web port / VeloxWebPortinteger / 443Derived web URL port
Web install path / VeloxWebInstallPathfolder / test c:\inetpub\Velox_Test\, production c:\inetpub\Velox\Used by API/OpenAPI export to wwwroot\openapi\; not the current Aspire deployment contract
Web URL / VeloxWebUrlderived read-only HTTPS URLDisplay/persisted address

:::warning Do not rely on the SSL checkbox as the security boundary Use an approved TLS termination and authentication/authorisation architecture. Validate the externally reachable route, certificate and identity controls independently. :::

Restart Velox API Service after listener or endpoint changes. Test the intended REST Flow through the deployed gateway and verify request/response plus Flow logs. See API deployment.