Change Mobile Redirect setting

PATCH

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/settings/mobile_redirect

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

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to Understanding Cloudflare Mobile Redirect for more information.

Request

Path Params

zone_identifier

string

required

Body Params application/json

value

object (mobile_redirect_value)

required

Value of the zone setting.

mobile_subdomain

string | null

optional

Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist).

>= 1 characters

Example:

status

optional

Whether or not mobile redirect is enabled.

Allowed values:

onoff

Default:

off

strip_uri

boolean

optional

Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.

Default:

false

Example:

false

Example

{
    "value": {
        "mobile_subdomain": "m",
        "status": "off",
        "strip_uri": false
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/zones//settings/mobile_redirect' \
--header 'Content-Type: application/json' \
--data-raw '{
    "value": {
        "mobile_subdomain": "m",
        "status": "off",
        "strip_uri": false
    }
}'

Responses

🟢200Change Mobile Redirect setting response

application/json

Body

allOf {2}

optional

allOf {2}

optional

object (api-response-single)

optional

object

optional

object

optional

result

object (Mobile Redirect)

optional

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to Understanding Cloudflare Mobile Redirect for more information.

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "editable": true,
        "id": "mobile_redirect",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "value": {
            "mobile_subdomain": "m",
            "status": "off",
            "strip_uri": false
        }
    },
    "success": true
}

🟢200Change Mobile Redirect setting response failure

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

Get Mobile Redirect setting

Get Network Error Logging setting