HomeGuidesAPI Reference
API Reference

Configure HTTP proxy settings for Orchestrator

Configures HTTP proxy settings used by Orchestrator for outbound connections to external services (Cloud Portal, AWS, Azure, Zscaler, Netskope). Password is encrypted before storage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Proxy configuration settings to apply

HTTP proxy configuration for Orchestrator outbound connections to external services.

boolean
required

Enable or disable proxy usage. When true, all outbound HTTP connections use the configured proxy.

string
length ≤ 255
^[a-zA-Z0-9._-]+$

Proxy server hostname or IP address. Required when useProxy is true.

integer
1 to 65535
Defaults to 80

Proxy server port number. Required when useProxy is true.

string
length ≤ 32

Username for proxy authentication. Optional; leave empty if proxy doesn't require authentication.

string
length ≤ 64

Password for proxy authentication. Returned decrypted in GET responses. Optional; leave empty if proxy doesn't require authentication.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json