Skip to content
Cloudflare API
Start here
API Reference
AI Gateway
Dynamic Routing

Update an AI Gateway Dynamic Route.

ai_gateway.dynamic_routing.update(strid, DynamicRoutingUpdateParams**kwargs) -> DynamicRoutingUpdateResponse
PATCH/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Update an AI Gateway Dynamic Route.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
AI Gateway Write
ParametersExpand Collapse
account_id: str
gateway_id: str
id: str
name: str
ReturnsExpand Collapse
class DynamicRoutingUpdateResponse: …
route: Route
id: str
account_tag: str
created_at: datetime
formatdate-time
deployment: RouteDeployment
created_at: str
deployment_id: str
version_id: str
elements: List[RouteElement]
One of the following:
class RouteElementUnionMember0: …
id: str
outputs: RouteElementUnionMember0Outputs
type: Literal["start"]
class RouteElementUnionMember1: …
id: str
outputs: RouteElementUnionMember1Outputs
false: RouteElementUnionMember1OutputsFalse_
element_id: str
true: RouteElementUnionMember1OutputsTrue_
element_id: str
properties: RouteElementUnionMember1Properties
conditions: Optional[object]
type: Literal["conditional"]
class RouteElementUnionMember2: …
id: str
outputs: Dict[str, RouteElementUnionMember2Outputs]
element_id: str
type: Literal["percentage"]
class RouteElementUnionMember3: …
id: str
outputs: RouteElementUnionMember3Outputs
fallback: RouteElementUnionMember3OutputsFallback
element_id: str
success: RouteElementUnionMember3OutputsSuccess
element_id: str
properties: RouteElementUnionMember3Properties
key: str
limit: float
limit_type: Literal["count", "cost"]
One of the following:
"count"
"cost"
window: float
type: Literal["rate"]
class RouteElementUnionMember4: …
id: str
outputs: RouteElementUnionMember4Outputs
fallback: RouteElementUnionMember4OutputsFallback
element_id: str
success: RouteElementUnionMember4OutputsSuccess
element_id: str
properties: RouteElementUnionMember4Properties
model: str
provider: str
retries: float
timeout: float
type: Literal["model"]
class RouteElementUnionMember5: …
id: str
outputs: Dict[str, RouteElementUnionMember5Outputs]
element_id: str
type: Literal["end"]
gateway_id: str
modified_at: datetime
formatdate-time
name: str
version: RouteVersion
active: Literal["true", "false"]
One of the following:
"true"
"false"
created_at: str
data: str
version_id: str
success: bool

Update an AI Gateway Dynamic Route.

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
dynamic_routing = client.ai_gateway.dynamic_routing.update(
    id="54442216",
    account_id="0d37909e38d3e99c29fa2cd343ac421a",
    gateway_id="54442216",
    name="Route Name",
)
print(dynamic_routing.route)
{
  "route": {
    "id": "id",
    "account_tag": "account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "deployment": {
      "created_at": "created_at",
      "deployment_id": "deployment_id",
      "version_id": "version_id"
    },
    "elements": [
      {
        "id": "id",
        "outputs": {
          "next": {
            "elementId": "elementId"
          }
        },
        "type": "start"
      }
    ],
    "gateway_id": "gateway_id",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "version": {
      "active": "true",
      "created_at": "created_at",
      "data": "data",
      "version_id": "version_id"
    }
  },
  "success": true
}
Returns Examples
{
  "route": {
    "id": "id",
    "account_tag": "account_tag",
    "created_at": "2019-12-27T18:11:19.117Z",
    "deployment": {
      "created_at": "created_at",
      "deployment_id": "deployment_id",
      "version_id": "version_id"
    },
    "elements": [
      {
        "id": "id",
        "outputs": {
          "next": {
            "elementId": "elementId"
          }
        },
        "type": "start"
      }
    ],
    "gateway_id": "gateway_id",
    "modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "version": {
      "active": "true",
      "created_at": "created_at",
      "data": "data",
      "version_id": "version_id"
    }
  },
  "success": true
}