Update URL Normalization settings

client.urlNormalization.update(, ?): URLNormalizationUpdateResponse { scope, type }

PUT/zones/{zone_id}/url_normalization

Updates the URL Normalization settings.

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)

Response Compression WriteConfig Settings WriteDynamic URL Redirects WriteCache Settings WriteCustom Errors WriteOrigin WriteManaged headers WriteZone Transform Rules WriteMass URL Redirects WriteMagic Firewall WriteL4 DDoS Managed Ruleset WriteHTTP DDoS Managed Ruleset WriteSanitize WriteTransform Rules WriteSelect Configuration WriteBot Management WriteZone WAF WriteAccount WAF WriteAccount Rulesets WriteLogs WriteLogs Write

ParametersExpand Collapse

params: URLNormalizationUpdateParams { zone_id, scope, type }

zone_id: string

Path param: The unique ID of the zone.

scope: "incoming" | "both" | "none"

Body param: The scope of the URL normalization.

One of the following:

"incoming"

"both"

"none"

type: "cloudflare" | "rfc3986"

Body param: The type of URL normalization performed by Cloudflare.

One of the following:

"cloudflare"

"rfc3986"

ReturnsExpand Collapse

URLNormalizationUpdateResponse { scope, type }

A result.

scope: "incoming" | "both" | "none"

The scope of the URL normalization.

One of the following:

"incoming"

"both"

"none"

type: "cloudflare" | "rfc3986"

The type of URL normalization performed by Cloudflare.

One of the following:

"cloudflare"

"rfc3986"

Update URL Normalization settings

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const urlNormalization = await client.urlNormalization.update({
  zone_id: '9f1839b6152d298aca64c4e906b6d074',
  scope: 'incoming',
  type: 'cloudflare',
});

console.log(urlNormalization.scope);

{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "result": {
    "scope": "incoming",
    "type": "cloudflare"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "result": {
    "scope": "incoming",
    "type": "cloudflare"
  },
  "success": true
}