Edit NEL setting

PATCH/zones/{zone_id}/settings/nel

Updates the Network Error Logging (NEL) setting for a zone. Requires the NEL product feature to be enabled for the zone. The setting controls whether browsers report network errors to Cloudflare’s NEL endpoint.

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)

Zone Settings Write

Path ParametersExpand Collapse

zone_id: string

Identifier of the zone.

maxLength32

Body ParametersJSONExpand Collapse

value: object { enabled }

The NEL configuration value.

enabled: boolean

Whether Network Error Logging is enabled for the zone. When enabled, browsers report network errors to Cloudflare’s NEL endpoint.

ReturnsExpand Collapse

errors: array of object { code, message }

code: number

Error or message code.

message: string

Human-readable message.

messages: array of object { code, message }

code: number

Error or message code.

message: string

Human-readable message.

result: Setting { id, editable, modified_on, value }

A zone-scoped NEL configuration setting.

id: "nel"

Zone setting identifier.

editable: boolean

Whether the setting is editable. This is false when the zone’s plan does not include NEL or the NEL product feature is not enabled.

modified_on: string

When the setting was last modified. A zero value (0001-01-01T00:00:00Z) indicates the setting has never been explicitly set and is using the default value.

formatdate-time

value: object { enabled }

The NEL configuration value.

enabled: boolean

Whether Network Error Logging is enabled for the zone. When enabled, browsers report network errors to Cloudflare’s NEL endpoint.

success: boolean

Whether the API call was successful.

Edit NEL setting

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/settings/nel \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "value": {
            "enabled": false
          }
        }'

{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "nel",
    "modified_on": "2024-01-15T10:30:00Z",
    "value": {
      "enabled": true
    }
  },
  "success": true
}

{
  "errors": [
    {
      "code": 1001,
      "message": "invalid_content_type"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1001,
      "message": "invalid_json_body"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1001,
      "message": "missing_value"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1009,
      "message": "auth.not_authorized"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1010,
      "message": "auth.forbidden"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1000,
      "message": "internal_error"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": {
    "editable": true,
    "id": "nel",
    "modified_on": "2024-01-15T10:30:00Z",
    "value": {
      "enabled": true
    }
  },
  "success": true
}

{
  "errors": [
    {
      "code": 1001,
      "message": "invalid_content_type"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1001,
      "message": "invalid_json_body"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1001,
      "message": "missing_value"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1009,
      "message": "auth.not_authorized"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1010,
      "message": "auth.forbidden"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}

{
  "errors": [
    {
      "code": 1000,
      "message": "internal_error"
    }
  ],
  "messages": [],
  "result": null,
  "success": false
}