cloudflare/resources/dns/firewall/firewall.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as FirewallAPI from 'cloudflare/resources/dns/firewall/firewall';
import * as AnalyticsAPI from 'cloudflare/resources/dns/firewall/analytics/analytics';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class FirewallResource extends APIResource {
    analytics: AnalyticsAPI.Analytics;
    /**
     * Create a configured DNS Firewall Cluster.
     */
    create(params: FirewallCreateParams, options?: Core.RequestOptions): Core.APIPromise<Firewall>;
    /**
     * List configured DNS Firewall clusters for an account.
     */
    list(params: FirewallListParams, options?: Core.RequestOptions): Core.PagePromise<FirewallsV4PagePaginationArray, Firewall>;
    /**
     * Delete a configured DNS Firewall Cluster.
     */
    delete(dnsFirewallId: string, params: FirewallDeleteParams, options?: Core.RequestOptions): Core.APIPromise<FirewallDeleteResponse>;
    /**
     * Modify a DNS Firewall Cluster configuration.
     */
    edit(dnsFirewallId: string, params: FirewallEditParams, options?: Core.RequestOptions): Core.APIPromise<Firewall>;
    /**
     * Show a single configured DNS Firewall cluster for an account.
     */
    get(dnsFirewallId: string, params: FirewallGetParams, options?: Core.RequestOptions): Core.APIPromise<Firewall>;
}
export declare class FirewallsV4PagePaginationArray extends V4PagePaginationArray<Firewall> {
}
/**
 * Attack mitigation settings.
 */
export interface AttackMitigation {
    /**
     * When enabled, random-prefix attacks are automatically mitigated and the upstream
     * DNS servers protected.
     */
    enabled?: boolean;
    /**
     * Only mitigate attacks when upstream servers seem unhealthy.
     */
    only_when_upstream_unhealthy?: boolean;
}
export interface Firewall {
    /**
     * Identifier
     */
    id: string;
    /**
     * Deprecate the response to ANY requests.
     */
    deprecate_any_requests: boolean;
    dns_firewall_ips: Array<FirewallIPs>;
    /**
     * Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
     */
    ecs_fallback: boolean;
    /**
     * Maximum DNS Cache TTL.
     */
    maximum_cache_ttl: number;
    /**
     * Minimum DNS Cache TTL.
     */
    minimum_cache_ttl: number;
    /**
     * Last modification of DNS Firewall cluster.
     */
    modified_on: string;
    /**
     * DNS Firewall Cluster Name.
     */
    name: string;
    upstream_ips: Array<UpstreamIPs>;
    /**
     * Attack mitigation settings.
     */
    attack_mitigation?: AttackMitigation | null;
    /**
     * Negative DNS Cache TTL.
     */
    negative_cache_ttl?: number | null;
    /**
     * Ratelimit in queries per second per datacenter (applies to DNS queries sent to
     * the upstream nameservers configured on the cluster).
     */
    ratelimit?: number | null;
    /**
     * Number of retries for fetching DNS responses from upstream nameservers (not
     * counting the initial attempt).
     */
    retries?: number;
}
/**
 * Cloudflare-assigned DNS IPv4 Address.
 */
export type FirewallIPs = string | string;
/**
 * Upstream DNS Server IPv4 Address.
 */
export type UpstreamIPs = string | string;
export interface FirewallDeleteResponse {
    /**
     * Identifier
     */
    id?: string;
}
export interface FirewallCreateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: DNS Firewall Cluster Name.
     */
    name: string;
    /**
     * Body param:
     */
    upstream_ips: Array<UpstreamIPs>;
    /**
     * Body param: Attack mitigation settings.
     */
    attack_mitigation?: AttackMitigation | null;
    /**
     * Body param: Deprecate the response to ANY requests.
     */
    deprecate_any_requests?: boolean;
    /**
     * Body param: Forward client IP (resolver) subnet if no EDNS Client Subnet is
     * sent.
     */
    ecs_fallback?: boolean;
    /**
     * Body param: Maximum DNS Cache TTL.
     */
    maximum_cache_ttl?: number;
    /**
     * Body param: Minimum DNS Cache TTL.
     */
    minimum_cache_ttl?: number;
    /**
     * Body param: Negative DNS Cache TTL.
     */
    negative_cache_ttl?: number | null;
    /**
     * Body param: Ratelimit in queries per second per datacenter (applies to DNS
     * queries sent to the upstream nameservers configured on the cluster).
     */
    ratelimit?: number | null;
    /**
     * Body param: Number of retries for fetching DNS responses from upstream
     * nameservers (not counting the initial attempt).
     */
    retries?: number;
}
export interface FirewallListParams extends V4PagePaginationArrayParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
}
export interface FirewallDeleteParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    body: unknown;
}
export interface FirewallEditParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: Deprecate the response to ANY requests.
     */
    deprecate_any_requests: boolean;
    /**
     * Body param:
     */
    dns_firewall_ips: Array<FirewallIPs>;
    /**
     * Body param: Forward client IP (resolver) subnet if no EDNS Client Subnet is
     * sent.
     */
    ecs_fallback: boolean;
    /**
     * Body param: Maximum DNS Cache TTL.
     */
    maximum_cache_ttl: number;
    /**
     * Body param: Minimum DNS Cache TTL.
     */
    minimum_cache_ttl: number;
    /**
     * Body param: DNS Firewall Cluster Name.
     */
    name: string;
    /**
     * Body param:
     */
    upstream_ips: Array<UpstreamIPs>;
    /**
     * Body param: Attack mitigation settings.
     */
    attack_mitigation?: AttackMitigation | null;
    /**
     * Body param: Negative DNS Cache TTL.
     */
    negative_cache_ttl?: number | null;
    /**
     * Body param: Ratelimit in queries per second per datacenter (applies to DNS
     * queries sent to the upstream nameservers configured on the cluster).
     */
    ratelimit?: number | null;
    /**
     * Body param: Number of retries for fetching DNS responses from upstream
     * nameservers (not counting the initial attempt).
     */
    retries?: number;
}
export interface FirewallGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace FirewallResource {
    export import AttackMitigation = FirewallAPI.AttackMitigation;
    export import Firewall = FirewallAPI.Firewall;
    export import FirewallIPs = FirewallAPI.FirewallIPs;
    export import UpstreamIPs = FirewallAPI.UpstreamIPs;
    export import FirewallDeleteResponse = FirewallAPI.FirewallDeleteResponse;
    export import FirewallsV4PagePaginationArray = FirewallAPI.FirewallsV4PagePaginationArray;
    export import FirewallCreateParams = FirewallAPI.FirewallCreateParams;
    export import FirewallListParams = FirewallAPI.FirewallListParams;
    export import FirewallDeleteParams = FirewallAPI.FirewallDeleteParams;
    export import FirewallEditParams = FirewallAPI.FirewallEditParams;
    export import FirewallGetParams = FirewallAPI.FirewallGetParams;
    export import Analytics = AnalyticsAPI.Analytics;
}
//# sourceMappingURL=firewall.d.ts.map