ExternalProxy

The port number of the proxy server. Valid range: 1-65535.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes

The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: [a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*

Required: Yes

Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).

Type: ProxyCredentials object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Optional array of domain patterns that should route through this specific proxy. Supports .example.com for subdomain matching (matches any subdomain of example.com) or example.com for exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: (\.)?[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*

Required: No