Ana içeriğe atla

​
Endpoint

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

​
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

{
  "routingAddressList": [
    {
      "address": "https://backend1.example.com",
      "weight": 100,
      "soapType": "SOAP11"
    },
    {
      "address": "https://backend2.example.com",
      "weight": 50,
      "soapType": "SOAP11"
    }
  ]
}

​
Request Body Fields

The request body is an object containing an array of routing address objects.

​
Routing Address Object

FieldTypeRequiredDefaultDescription
addressstringYes-Backend address URL
weightintegerNo1Load balancing weight (required if loadBalanceAlgorithm=WEIGHTED)
soapTypestringNo*SOAP11SOAP version (required if API type is SOAP)

​
EnumSoapApiPortType

  • SOAP11 - SOAP 1.1
  • SOAP12 - SOAP 1.2

​
Request Body Object

FieldTypeRequiredDescription
routingAddressListarrayYesArray of routing address objects

​
Note

  • Request body must be an object with routingAddressList array
  • For REST APIs, soapType is not required
  • For SOAP APIs, soapType defaults to SOAP11 if not provided
  • Weight is used when load balancing algorithm is WEIGHTED

​
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": "Address is required"
}

​
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: Update REST API Backend Addresses

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/addresses/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "routingAddressList": [
      {
        "address": "https://backend1.example.com",
        "weight": 100
      },
      {
        "address": "https://backend2.example.com",
        "weight": 50
      }
    ]
  }'

​
Example 2: Update SOAP API Backend Addresses

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/addresses/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "routingAddressList": [
      {
        "address": "https://soap-backend.example.com/Service",
        "weight": 100,
        "soapType": "SOAP11"
      },
      {
        "address": "https://soap-backend2.example.com/Service",
        "weight": 50,
        "soapType": "SOAP12"
      }
    ]
  }'

​
Notes and Warnings

  • Request Body Format: Request body must be an object with routingAddressList array
  • Address Format: Must be a valid URL (http:// or https://)
  • Weight: Used for weighted load balancing (higher weight = more traffic)
  • SOAP Type: Required for SOAP APIs, defaults to SOAP11 if not provided
  • Empty Array: Empty array removes all routing addresses (routing will fail)
  • Load Balancing: Configure load balancing algorithm separately (via routing settings)

​
Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.