Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/circuit-breaker/

​
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

{
  "circuitBreakerEnabled": true,
  "errorWindow": 60,
  "errorThresholdValue": 5,
  "enumErrorThresholdType": "COUNT",
  "sleepWindow": 30,
  "halfOpenEnabled": true,
  "deploy": false,
  "deployTargetEnvironmentNameList": []
}

​
Request Body Fields

FieldTypeRequiredDefaultDescription
circuitBreakerEnabledbooleanNo-Enable/disable circuit breaker
errorWindowintegerNo-Time window in seconds to count errors
errorThresholdValueintegerNo-Error threshold value (count or percentage)
enumErrorThresholdTypestringNo-Error threshold type
sleepWindowintegerNo-Sleep window in seconds (circuit breaker stays open)
halfOpenEnabledbooleanNo-Enable half-open state (test requests)
deploybooleanNofalseIf true, deploy the API proxy after saving changes
deployTargetEnvironmentNameListarray[string]No-List of environment names to deploy to (required when deploy=true)

​
EnumErrorThresholdType

  • COUNT - Error threshold is a count (e.g., 5 errors)
  • PERCENT - Error threshold is a percentage (e.g., 50% error rate)
Note: All fields are optional. Only provided fields are updated.

​
Response

​
Success Response (200 OK)

{
  "success": true
}
When deploy=true is specified: 
{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
deploymentResultobjectDeployment result (only present when deploy=true)
deploymentResult.successbooleanOverall deployment success
deploymentResult.deploymentResultsarrayIndividual environment deployment results

​
Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Invalid circuit breaker settings"
}

​
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: Enable Circuit Breaker with Count Threshold

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/circuit-breaker/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "circuitBreakerEnabled": true,
    "errorWindow": 60,
    "errorThresholdValue": 5,
    "enumErrorThresholdType": "COUNT",
    "sleepWindow": 30,
    "halfOpenEnabled": true
  }'

​
Example 2: Enable Circuit Breaker with Percentage Threshold

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/circuit-breaker/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "circuitBreakerEnabled": true,
    "errorWindow": 120,
    "errorThresholdValue": 50,
    "enumErrorThresholdType": "PERCENT",
    "sleepWindow": 60,
    "halfOpenEnabled": false
  }'

​
Example 3: Save and Deploy

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/circuit-breaker/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "circuitBreakerEnabled": true,
    "errorWindow": 60,
    "errorThresholdValue": 5,
    "enumErrorThresholdType": "COUNT",
    "sleepWindow": 30,
    "halfOpenEnabled": true,
    "deploy": true,
    "deployTargetEnvironmentNameList": ["production"]
  }'

​
Notes and Warnings

  • Error Window: Time window in seconds during which errors are counted
  • Error Threshold: When threshold is reached, circuit breaker opens
  • Sleep Window: Duration in seconds that circuit breaker stays open before attempting half-open
  • Half-Open: When enabled, allows test requests to check if backend recovered
  • Threshold Type: COUNT uses absolute number, PERCENT uses percentage of requests
  • Deploy: When deploy=true, the API proxy is automatically deployed to the specified environments after saving

​
Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.