ApiProxy

Update Connection Settings

Updates Connection settings for the specified API Proxy

patch/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/connection/

Request

Path parameters

projectNamestring required
apiProxyNamestring required

Request body

deployboolean

If true, deploy the API Proxy after saving changes

deployTargetEnvironmentNameListstring[]

List of environment names to deploy to (required when deploy=true)

connectionSettingsEnabledboolean

Enable custom connection settings (overrides system defaults)

connectTimeoutinteger

Connection timeout in milliseconds

readTimeoutinteger

Read timeout in milliseconds

connectionRequestTimeoutinteger

Connection request timeout in milliseconds

redirectsEnabledboolean

Enable HTTP redirect following

maxRedirectsinteger

Maximum number of redirects to follow

relativeRedirectsAllowedboolean

Allow relative redirects

preserveHttpMethodOnRedirectboolean

Preserve HTTP method and body on 301/302/303/307/308 redirects (default: false — 301/302/303 downgrade to GET and drop the body)

enableStreamingboolean

Enable streaming for large responses

retryCountinteger

Number of retries for failed requests (default: 0)

failoverRetryCountinteger

Number of retries during failover (default: 0)

ignoreRoutingErrorboolean

Ignore routing errors

connectionPoolManagementType'GENERAL' | 'CUSTOM' | 'NONE'

Connection pool management type: GENERAL, PER_ROUTE, CUSTOM

customConnectionPoolSizeinteger

Custom connection pool size (only when connectionPoolManagementType is CUSTOM)

validateAfterInactivityinteger

Stale connection check interval in milliseconds (default: 2000)

idleConnectionTimeoutinteger

Idle connection cleanup timeout in seconds (default: 30)

hopByHopHeadersstring[]

List of hop-by-hop headers to remove before forwarding to backend

sendUserAgentToBackendboolean

Send User-Agent header to backend

userAgentValuestring

Custom User-Agent header value

doNotRouteZeroValueContentLengthboolean

Do not route requests with Content-Length: 0

enableDownloadboolean

Enable file download support

useBase64TextForCompressedResponseboolean

When true, gateway returns Base64-encoded text for compressed response (legacy client compatibility). When false (default), gateway returns raw byte array.

requestCharsetOverridestring

Override request charset (e.g. ISO-8859-9, windows-1252). null = read from header

responseCharsetOverridestring

Override response charset (e.g. ISO-8859-9, windows-1252). null = read from header

requestDecompressOverride'GZIP' | 'DEFLATE' | 'BR' | 'ZSTD' | 'NOT_APPLY' | 'MIRROR_SERVER_RESPONSE' | 'AUTO_BY_CLIENT_ACCEPT_ENCODING'

Override request decompress encoding. null = auto (CE header + magic byte), NOT_APPLY = skip decompress

requestCompressOverride'GZIP' | 'DEFLATE' | 'BR' | 'ZSTD' | 'NOT_APPLY' | 'MIRROR_SERVER_RESPONSE' | 'AUTO_BY_CLIENT_ACCEPT_ENCODING'

Override request compress encoding (to backend). null = auto, NOT_APPLY = skip compress

responseDecompressOverride'GZIP' | 'DEFLATE' | 'BR' | 'ZSTD' | 'NOT_APPLY' | 'MIRROR_SERVER_RESPONSE' | 'AUTO_BY_CLIENT_ACCEPT_ENCODING'

Override response decompress encoding (from backend). null = auto (CE header + magic byte), NOT_APPLY = skip decompress

responseCompressOverride'GZIP' | 'DEFLATE' | 'BR' | 'ZSTD' | 'NOT_APPLY' | 'MIRROR_SERVER_RESPONSE' | 'AUTO_BY_CLIENT_ACCEPT_ENCODING'

Override response compress encoding (to client). null = auto, NOT_APPLY = skip compress

retryDelayType'NO_DELAY' | 'FIXED' | 'EXPONENTIAL'

Retry delay strategy: NO_DELAY, FIXED, EXPONENTIAL_BACKOFF

retryFixedDelayMsinteger

Fixed delay between retries in milliseconds

retryInitialDelayMsinteger

Initial delay for exponential backoff in milliseconds

retryMaxDelayMsinteger

Maximum delay for exponential backoff in milliseconds

retryBackoffMultipliernumber double

Backoff multiplier for exponential delay

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

No recorded changes to this operation across all 21 revisions of this API.