Ana içeriğe atla

​
Endpoint

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

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes
Content-Typeapplication/jsonYes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name

​
Request Body

​
Full JSON Body Example

{
  "connectionSettingsEnabled": true,
  "connectTimeout": 30,
  "readTimeout": 60,
  "connectionRequestTimeout": 30,
  "redirectsEnabled": true,
  "maxRedirects": 50,
  "relativeRedirectsAllowed": true,
  "disableContentCompression": false,
  "enableStreaming": false,
  "retryCount": 3,
  "failoverRetryCount": 2,
  "ignoreRoutingError": false,
  "connectionPoolManagementType": "GENERAL",
  "customConnectionPoolSize": 8
}

​
Request Body Fields

FieldTypeRequiredDefaultDescription
connectionSettingsEnabledbooleanNo-Enable/disable custom connection settings
connectTimeoutintegerNo-Connection timeout in seconds
readTimeoutintegerNo-Read timeout in seconds
connectionRequestTimeoutintegerNo-Connection request timeout in seconds
redirectsEnabledbooleanNo-Enable/disable HTTP redirects
maxRedirectsintegerNo-Maximum number of redirects
relativeRedirectsAllowedbooleanNo-Allow relative redirects
disableContentCompressionbooleanNo-Disable content compression
enableStreamingbooleanNo-Enable streaming mode
retryCountintegerNo-Number of retries on failure
failoverRetryCountintegerNo-Number of failover retries
ignoreRoutingErrorbooleanNo-Ignore routing errors
connectionPoolManagementTypestringNo-Connection pool management type
customConnectionPoolSizeintegerNo*-Custom connection pool size (required if connectionPoolManagementType=CUSTOM)

​
EnumConnectionPoolManagementType

  • GENERAL - General connection pool (shared pool)
  • CUSTOM - Custom connection pool (requires customConnectionPoolSize)
  • NONE - No connection pool
Note: All fields are optional. Only provided fields are updated.

​
Response

​
Success Response (200 OK)

{
  "success": true
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Custom connection pool size is required when connectionPoolManagementType is CUSTOM"
}

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​
Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "ApiProxy (name: MyAPI) was not found!"
}

​
cURL Example

​
Example 1: Configure Connection Timeouts

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/connection/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionSettingsEnabled": true,
    "connectTimeout": 30,
    "readTimeout": 60,
    "connectionRequestTimeout": 30,
    "retryCount": 3,
    "failoverRetryCount": 2
  }'

​
Example 2: Configure Custom Connection Pool

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/connection/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionSettingsEnabled": true,
    "connectionPoolManagementType": "CUSTOM",
    "customConnectionPoolSize": 20,
    "connectTimeout": 60,
    "readTimeout": 120
  }'

​
Notes and Warnings

  • Timeouts: All timeout values are in seconds
  • Connection Pool: CUSTOM requires customConnectionPoolSize to be set
  • Retries: retryCount retries on same backend, failoverRetryCount tries failover backends
  • Redirects: When redirectsEnabled=true, HTTP redirects are followed (max maxRedirects)
  • Streaming: When enableStreaming=true, response is streamed instead of buffered
  • Content Compression: When disableContentCompression=true, content compression is disabled

​
Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.