cloudflare/resources/zones/settings/opportunistic-encryption.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as OpportunisticEncryptionAPI from 'cloudflare/resources/zones/settings/opportunistic-encryption';
export declare class OpportunisticEncryption extends APIResource {
    /**
     * Changes Opportunistic Encryption setting.
     */
    edit(params: OpportunisticEncryptionEditParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingOpportunisticEncryption>;
    /**
     * Gets Opportunistic Encryption setting.
     */
    get(params: OpportunisticEncryptionGetParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingOpportunisticEncryption>;
}
/**
 * Enables the Opportunistic Encryption feature for a zone.
 */
export interface ZoneSettingOpportunisticEncryption {
    /**
     * ID of the zone setting.
     */
    id: 'opportunistic_encryption';
    /**
     * Current value of the zone setting.
     */
    value: 'on' | 'off';
    /**
     * Whether or not this setting can be modified for this zone (based on your
     * Cloudflare plan level).
     */
    editable?: true | false;
    /**
     * last time this setting was modified.
     */
    modified_on?: string | null;
}
export interface OpportunisticEncryptionEditParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Body param: Value of the zone setting. Notes: Default value depends on the
     * zone's plan level.
     */
    value: 'on' | 'off';
}
export interface OpportunisticEncryptionGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace OpportunisticEncryption {
    export import ZoneSettingOpportunisticEncryption = OpportunisticEncryptionAPI.ZoneSettingOpportunisticEncryption;
    export import OpportunisticEncryptionEditParams = OpportunisticEncryptionAPI.OpportunisticEncryptionEditParams;
    export import OpportunisticEncryptionGetParams = OpportunisticEncryptionAPI.OpportunisticEncryptionGetParams;
}
//# sourceMappingURL=opportunistic-encryption.d.ts.map