Update Route

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/magic/routes/{route_identifier}

Last modified:2022-12-16 13:48:33

Update a specific Magic static route. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes.

Request

Path Params

route_identifier

string

required

account_identifier

string

required

Body Params application/json

description

string

route_components-schemas-description

optional

An optional human provided description of the static route.

Example:

New route for new prefix 203.0.113.1

nexthop

string

nexthop

required

The next-hop IP Address for the static route.

Example:

203.0.113.1

prefix

string

prefix

required

IP Prefix in Classless Inter-Domain Routing format.

Example:

192.0.2.0/24

priority

integer

route_components-schemas-priority

required

Priority of the static route.

scope

object

schemas-scope

optional

Used only for ECMP routes.

colo_names

array[string]

colo_names

optional

List of colo names for the ECMP scope.

colo_regions

array[string]

colo_regions

optional

List of colo regions for the ECMP scope.

weight

integer

schemas-weight

optional

Optional weight of the ECMP scope - if provided.

Example

{
    "description": "New route for new prefix 203.0.113.1",
    "nexthop": "203.0.113.1",
    "prefix": "192.0.2.0/24",
    "priority": 0,
    "scope": {
        "colo_names": [
            "den01"
        ],
        "colo_regions": [
            "APAC"
        ]
    },
    "weight": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//magic/routes/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "New route for new prefix 203.0.113.1",
    "nexthop": "203.0.113.1",
    "prefix": "192.0.2.0/24",
    "priority": 0,
    "scope": {
        "colo_names": [
            "den01"
        ],
        "colo_regions": [
            "APAC"
        ]
    },
    "weight": 0
}'

Responses

🟢200Update Route response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "modified": true,
        "modified_route": {}
    },
    "success": true
}

🟢200Update Route response failure

Modified at 2022-12-16 13:48:33

Route Details

List Managed Transforms