For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
  • Introduction
    • Overview
    • Retired adapters
      • Overview
        • Overview
        • Base properties
        • Authentication properties
        • SSL/TLS properties
        • Request properties
        • Healthcheck properties
        • Proxy properties
        • Throttle properties
        • Mongo properties
        • Deprecated properties
      • SSL/TLS
      • Throttling
      • Headers
      • Add dynamic headers
      • Add query parameters
      • Update adapter configuration
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Properties
  • Example
ConfigureService instance configuration

Proxy properties

Was this page helpful?
Previous

Throttle properties

Next
Built with

All proxy properties are defined within the proxy object in theItential Platform service instance configuration for the adapter.

Properties

PropertyTypeRequiredDescription
enabledbooleanYesDetermines whether requests to the external system must pass through a proxy.
hoststringYes (if enabled)Hostname of the proxy server.
portintegerYes (if enabled)Port of the proxy server.
protocolenumNo → httpProtocol to use for the proxy connection. Supported values: http, https, socks4, socks5.
usernamestringNoUsername for proxy authentication.
passwordstringNoPassword for proxy authentication.

Example

This example routes requests through a proxy server at https://myproxy.xyz.com:443 using proxy-specific credentials.

1"proxy": {
2  "enabled": true,
3  "host": "myproxy.xyz.com",
4  "port": 443,
5  "protocol": "https",
6  "username": "Itential",
7  "password": "letmein"
8}