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

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as OpportunisticOnionAPI from 'cloudflare/resources/zones/settings/opportunistic-onion';
export declare class OpportunisticOnion extends APIResource {
    /**
     * Add an Alt-Svc header to all legitimate requests from Tor, allowing the
     * connection to use our onion services instead of exit nodes.
     */
    edit(params: OpportunisticOnionEditParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingOpportunisticOnion>;
    /**
     * Add an Alt-Svc header to all legitimate requests from Tor, allowing the
     * connection to use our onion services instead of exit nodes.
     */
    get(params: OpportunisticOnionGetParams, options?: Core.RequestOptions): Core.APIPromise<ZoneSettingOpportunisticOnion>;
}
/**
 * Add an Alt-Svc header to all legitimate requests from Tor, allowing the
 * connection to use our onion services instead of exit nodes.
 */
export interface ZoneSettingOpportunisticOnion {
    /**
     * ID of the zone setting.
     */
    id: 'opportunistic_onion';
    /**
     * 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 OpportunisticOnionEditParams {
    /**
     * 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 OpportunisticOnionGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace OpportunisticOnion {
    export import ZoneSettingOpportunisticOnion = OpportunisticOnionAPI.ZoneSettingOpportunisticOnion;
    export import OpportunisticOnionEditParams = OpportunisticOnionAPI.OpportunisticOnionEditParams;
    export import OpportunisticOnionGetParams = OpportunisticOnionAPI.OpportunisticOnionGetParams;
}
//# sourceMappingURL=opportunistic-onion.d.ts.map