cloudflare/resources/zones/nel.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseNEL extends APIResource {
    static readonly _key: readonly ['zones', '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.
     *
     * @example
     * ```ts
     * const setting = await client.zones.nel.edit({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   value: { enabled: false },
     * });
     * ```
     */
    edit(params: NELEditParams, options?: RequestOptions): APIPromise<Setting>;
    /**
     * 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.
     *
     * @example
     * ```ts
     * const setting = await client.zones.nel.get({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    get(params: NELGetParams, options?: RequestOptions): APIPromise<Setting>;
}
export declare class NEL extends BaseNEL {
}
/**
 * A zone-scoped NEL configuration setting.
 */
export interface Setting {
    /**
     * Zone setting identifier.
     */
    id: 'nel';
    /**
     * 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.
     */
    editable: boolean;
    /**
     * 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.
     */
    modified_on: string;
    /**
     * The NEL configuration value.
     */
    value: Setting.Value;
}
export declare namespace Setting {
    /**
     * The NEL configuration value.
     */
    interface Value {
        /**
         * Whether Network Error Logging is enabled for the zone. When enabled, browsers
         * report network errors to Cloudflare's NEL endpoint.
         */
        enabled: boolean;
    }
}
export interface NELEditParams {
    /**
     * Path param: Identifier of the zone.
     */
    zone_id: string;
    /**
     * Body param: The NEL configuration value.
     */
    value: NELEditParams.Value;
}
export declare namespace NELEditParams {
    /**
     * The NEL configuration value.
     */
    interface Value {
        /**
         * Whether Network Error Logging is enabled for the zone. When enabled, browsers
         * report network errors to Cloudflare's NEL endpoint.
         */
        enabled: boolean;
    }
}
export interface NELGetParams {
    /**
     * Identifier of the zone.
     */
    zone_id: string;
}
export declare namespace NEL {
    export { type Setting as Setting, type NELEditParams as NELEditParams, type NELGetParams as NELGetParams };
}
//# sourceMappingURL=nel.d.ts.map