Aysali API icon

Aysali API

Interact with Aysali API

Instance → Set/Fetch Proxy

AI-generated

Summary

Configure or retrieve the proxy settings for a specified instance by enabling/disabling proxy integration or fetching current proxy configuration.

Inputs

  • Instance Name (required) — Specify the instance name that will use the proxy settings.
  • What Would You Like To Do (required) — Select whether to 'Set Proxy' to enable/disable proxy integration and provide proxy details, or 'Fetch Proxy' to retrieve current proxy settings.
  • Enable Proxy — Indicate whether to enable or disable proxy integration (only applicable when setting proxy).
  • Proxy Protocol — Choose the proxy protocol (HTTP or HTTPS) when setting proxy.
  • Proxy Host — Enter the proxy host address when setting proxy.
  • Proxy Port — Enter the proxy port when setting proxy.
  • Proxy Username — Enter the proxy username for authentication when setting proxy.
  • Proxy Password — Enter the proxy password for authentication when setting proxy.

Output shape

an object containing the proxy settings for the specified instance or confirmation of the updated proxy configuration

Output depends on selected action: for 'Set Proxy' it returns confirmation of the applied settings; for 'Fetch Proxy' it returns the current proxy configuration details of the instance.

Examples

Example 1: Set proxy for an instance

Specify instance name, select 'Set Proxy', enable proxy, provide protocol, host, port, username, and password.

Example 2: Fetch proxy configuration

Specify instance name and select 'Fetch Proxy' to retrieve existing proxy settings without alteration.

Links

Discussion