cloudflare/resources/zero-trust/gateway/logging.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseLogging extends APIResource {
    static readonly _key: readonly ['zeroTrust', 'gateway', 'logging'];
    /**
     * Update logging settings for the current Zero Trust account.
     *
     * @example
     * ```ts
     * const loggingSetting =
     *   await client.zeroTrust.gateway.logging.update({
     *     account_id: '699d98642c564d2e855e9661899b7252',
     *   });
     * ```
     */
    update(params: LoggingUpdateParams, options?: RequestOptions): APIPromise<LoggingSetting>;
    /**
     * Retrieve the current logging settings for the Zero Trust account.
     *
     * @example
     * ```ts
     * const loggingSetting =
     *   await client.zeroTrust.gateway.logging.get({
     *     account_id: '699d98642c564d2e855e9661899b7252',
     *   });
     * ```
     */
    get(params: LoggingGetParams, options?: RequestOptions): APIPromise<LoggingSetting>;
}
export declare class Logging extends BaseLogging {
}
export interface LoggingSetting {
    /**
     * Indicate whether to redact personally identifiable information from activity
     * logging (PII fields include source IP, user email, user ID, device ID, URL,
     * referrer, and user agent).
     */
    redact_pii?: boolean;
    /**
     * Configure logging settings for each rule type.
     */
    settings_by_rule_type?: LoggingSetting.SettingsByRuleType;
}
export declare namespace LoggingSetting {
    /**
     * Configure logging settings for each rule type.
     */
    interface SettingsByRuleType {
        /**
         * Configure logging settings for DNS firewall.
         */
        dns?: SettingsByRuleType.DNS;
        /**
         * Configure logging settings for HTTP/HTTPS firewall.
         */
        http?: SettingsByRuleType.HTTP;
        /**
         * Configure logging settings for Network firewall.
         */
        l4?: SettingsByRuleType.L4;
    }
    namespace SettingsByRuleType {
        /**
         * Configure logging settings for DNS firewall.
         */
        interface DNS {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
        /**
         * Configure logging settings for HTTP/HTTPS firewall.
         */
        interface HTTP {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
        /**
         * Configure logging settings for Network firewall.
         */
        interface L4 {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
    }
}
export interface LoggingUpdateParams {
    /**
     * Path param: Specify the Cloudflare account identifier.
     */
    account_id: string;
    /**
     * Body param: Indicate whether to redact personally identifiable information from
     * activity logging (PII fields include source IP, user email, user ID, device ID,
     * URL, referrer, and user agent).
     */
    redact_pii?: boolean;
    /**
     * Body param: Configure logging settings for each rule type.
     */
    settings_by_rule_type?: LoggingUpdateParams.SettingsByRuleType;
}
export declare namespace LoggingUpdateParams {
    /**
     * Configure logging settings for each rule type.
     */
    interface SettingsByRuleType {
        /**
         * Configure logging settings for DNS firewall.
         */
        dns?: SettingsByRuleType.DNS;
        /**
         * Configure logging settings for HTTP/HTTPS firewall.
         */
        http?: SettingsByRuleType.HTTP;
        /**
         * Configure logging settings for Network firewall.
         */
        l4?: SettingsByRuleType.L4;
    }
    namespace SettingsByRuleType {
        /**
         * Configure logging settings for DNS firewall.
         */
        interface DNS {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
        /**
         * Configure logging settings for HTTP/HTTPS firewall.
         */
        interface HTTP {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
        /**
         * Configure logging settings for Network firewall.
         */
        interface L4 {
            /**
             * Specify whether to log all requests to this service.
             */
            log_all?: boolean;
            /**
             * Specify whether to log only blocking requests to this service.
             */
            log_blocks?: boolean;
        }
    }
}
export interface LoggingGetParams {
    /**
     * Specify the Cloudflare account identifier.
     */
    account_id: string;
}
export declare namespace Logging {
    export { type LoggingSetting as LoggingSetting, type LoggingUpdateParams as LoggingUpdateParams, type LoggingGetParams as LoggingGetParams, };
}
//# sourceMappingURL=logging.d.mts.map