Get NEL setting

client.zones.nel.get(, ?): Setting { id, editable, modified_on, value }

GET/zones/{zone_id}/settings/nel

Fetches the Network Error Logging (NEL) setting for a zone. NEL allows browsers to report network errors to a configured endpoint. The setting is enabled by default for free and pro zones, and disabled by default for business and enterprise zones unless the NEL product feature is enabled.

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 Read

ParametersExpand Collapse

params: NELGetParams { zone_id }

zone_id: string

Identifier of the zone.

maxLength32

ReturnsExpand Collapse

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: Value { 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.

Get NEL setting

import Cloudflare from 'cloudflare';

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

const setting = await client.zones.nel.get({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });

console.log(setting.id);

{
  "errors": [],
  "messages": [],
  "result": {
    "editable": false,
    "id": "nel",
    "modified_on": "0001-01-01T00:00:00Z",
    "value": {
      "enabled": false
    }
  },
  "success": true
}

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

{
  "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": false,
    "id": "nel",
    "modified_on": "0001-01-01T00:00:00Z",
    "value": {
      "enabled": false
    }
  },
  "success": true
}

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

{
  "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
}