cloudflare/resources/zero-trust/devices/settings.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class Settings extends APIResource {
    /**
     * Updates the current device settings for a Zero Trust account.
     */
    update(params: SettingUpdateParams, options?: Core.RequestOptions): Core.APIPromise<DeviceSettings | null>;
    /**
     * Describes the current device settings for a Zero Trust account.
     */
    list(params: SettingListParams, options?: Core.RequestOptions): Core.APIPromise<DeviceSettings | null>;
    /**
     * Patches the current device settings for a Zero Trust account.
     */
    edit(params: SettingEditParams, options?: Core.RequestOptions): Core.APIPromise<DeviceSettings | null>;
}
export interface DeviceSettings {
    /**
     * Sets the time limit, in seconds, that a user can use an override code to bypass
     * WARP.
     */
    disable_for_time?: number;
    /**
     * Enable gateway proxy filtering on TCP.
     */
    gateway_proxy_enabled?: boolean;
    /**
     * Enable gateway proxy filtering on UDP.
     */
    gateway_udp_proxy_enabled?: boolean;
    /**
     * Enable installation of cloudflare managed root certificate.
     */
    root_certificate_installation_enabled?: boolean;
    /**
     * Enable using CGNAT virtual IPv4.
     */
    use_zt_virtual_ip?: boolean;
}
export interface SettingUpdateParams {
    /**
     * Path param:
     */
    account_id: string;
    /**
     * Body param: Sets the time limit, in seconds, that a user can use an override
     * code to bypass WARP.
     */
    disable_for_time?: number;
    /**
     * Body param: Enable gateway proxy filtering on TCP.
     */
    gateway_proxy_enabled?: boolean;
    /**
     * Body param: Enable gateway proxy filtering on UDP.
     */
    gateway_udp_proxy_enabled?: boolean;
    /**
     * Body param: Enable installation of cloudflare managed root certificate.
     */
    root_certificate_installation_enabled?: boolean;
    /**
     * Body param: Enable using CGNAT virtual IPv4.
     */
    use_zt_virtual_ip?: boolean;
}
export interface SettingListParams {
    account_id: string;
}
export interface SettingEditParams {
    /**
     * Path param:
     */
    account_id: string;
    /**
     * Body param: Sets the time limit, in seconds, that a user can use an override
     * code to bypass WARP.
     */
    disable_for_time?: number;
    /**
     * Body param: Enable gateway proxy filtering on TCP.
     */
    gateway_proxy_enabled?: boolean;
    /**
     * Body param: Enable gateway proxy filtering on UDP.
     */
    gateway_udp_proxy_enabled?: boolean;
    /**
     * Body param: Enable installation of cloudflare managed root certificate.
     */
    root_certificate_installation_enabled?: boolean;
    /**
     * Body param: Enable using CGNAT virtual IPv4.
     */
    use_zt_virtual_ip?: boolean;
}
export declare namespace Settings {
    export { type DeviceSettings as DeviceSettings, type SettingUpdateParams as SettingUpdateParams, type SettingListParams as SettingListParams, type SettingEditParams as SettingEditParams, };
}
//# sourceMappingURL=settings.d.ts.map