cloudflare/resources/cache/cache.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CacheReserveAPI from 'cloudflare/resources/cache/cache-reserve';
import * as RegionalTieredCacheAPI from 'cloudflare/resources/cache/regional-tiered-cache';
import * as SmartTieredCacheAPI from 'cloudflare/resources/cache/smart-tiered-cache';
import * as VariantsAPI from 'cloudflare/resources/cache/variants';
export declare class Cache extends APIResource {
    cacheReserve: CacheReserveAPI.CacheReserveResource;
    smartTieredCache: SmartTieredCacheAPI.SmartTieredCache;
    variants: VariantsAPI.Variants;
    regionalTieredCache: RegionalTieredCacheAPI.RegionalTieredCacheResource;
    /**
     * ### Purge All Cached Content
     *
     * Removes ALL files from Cloudflare's cache. All tiers can purge everything.
     *
     * ### Purge Cached Content by URL
     *
     * Granularly removes one or more files from Cloudflare's cache by specifying URLs.
     * All tiers can purge by URL.
     *
     * To purge files with custom cache keys, include the headers used to compute the
     * cache key as in the example. If you have a device type or geo in your cache key,
     * you will need to include the CF-Device-Type or CF-IPCountry headers. If you have
     * lang in your cache key, you will need to include the Accept-Language header.
     *
     * **NB:** When including the Origin header, be sure to include the **scheme** and
     * **hostname**. The port number can be omitted if it is the default port (80 for
     * http, 443 for https), but must be included otherwise. **NB:** For Zones on
     * Free/Pro/Business plan, you may purge up to 30 URLs in one API call. For Zones
     * on Enterprise plan, you may purge up to 500 URLs in one API call.
     *
     * ### Purge Cached Content by Tag, Host or Prefix
     *
     * Granularly removes one or more files from Cloudflare's cache either by
     * specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise
     * customers are permitted to purge by Tag, Host or Prefix.
     *
     * **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000
     * purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or
     * prefixes in one API call. This rate limit can be raised for customers who need
     * to purge at higher volume.
     */
    purge(params: CachePurgeParams, options?: Core.RequestOptions): Core.APIPromise<CachePurgeResponse | null>;
}
export interface CachePurgeResponse {
    /**
     * Identifier
     */
    id: string;
}
export type CachePurgeParams = CachePurgeParams.CachePurgeTags | CachePurgeParams.CachePurgeHosts | CachePurgeParams.CachePurgePrefixes | CachePurgeParams.CachePurgeEverything | CachePurgeParams.CachePurgeFiles;
export declare namespace CachePurgeParams {
    interface CachePurgeTags {
        /**
         * Path param:
         */
        zone_id: string;
        /**
         * Body param:
         */
        tags?: Array<string>;
    }
    interface CachePurgeHosts {
        /**
         * Path param:
         */
        zone_id: string;
        /**
         * Body param:
         */
        hosts?: Array<string>;
    }
    interface CachePurgePrefixes {
        /**
         * Path param:
         */
        zone_id: string;
        /**
         * Body param:
         */
        prefixes?: Array<string>;
    }
    interface CachePurgeEverything {
        /**
         * Path param:
         */
        zone_id: string;
        /**
         * Body param:
         */
        purge_everything?: boolean;
    }
    interface CachePurgeFiles {
        /**
         * Path param:
         */
        zone_id: string;
        /**
         * Body param:
         */
        files?: Array<string | CachePurgeParams.CachePurgeFiles.CachePurgeURLAndHeaders>;
    }
    namespace CachePurgeFiles {
        interface CachePurgeURLAndHeaders {
            headers?: unknown;
            url?: string;
        }
    }
}
export declare namespace Cache {
    export import CacheReserveResource = CacheReserveAPI.CacheReserveResource;
    export import CacheReserve = CacheReserveAPI.CacheReserve;
    export import CacheReserveClear = CacheReserveAPI.CacheReserveClear;
    export import CacheReserveClearResponse = CacheReserveAPI.CacheReserveClearResponse;
    export import CacheReserveEditResponse = CacheReserveAPI.CacheReserveEditResponse;
    export import CacheReserveGetResponse = CacheReserveAPI.CacheReserveGetResponse;
    export import CacheReserveStatusResponse = CacheReserveAPI.CacheReserveStatusResponse;
    export import CacheReserveClearParams = CacheReserveAPI.CacheReserveClearParams;
    export import CacheReserveEditParams = CacheReserveAPI.CacheReserveEditParams;
    export import CacheReserveGetParams = CacheReserveAPI.CacheReserveGetParams;
    export import CacheReserveStatusParams = CacheReserveAPI.CacheReserveStatusParams;
    export import SmartTieredCache = SmartTieredCacheAPI.SmartTieredCache;
    export import SmartTieredCacheDeleteResponse = SmartTieredCacheAPI.SmartTieredCacheDeleteResponse;
    export import SmartTieredCacheEditResponse = SmartTieredCacheAPI.SmartTieredCacheEditResponse;
    export import SmartTieredCacheGetResponse = SmartTieredCacheAPI.SmartTieredCacheGetResponse;
    export import SmartTieredCacheDeleteParams = SmartTieredCacheAPI.SmartTieredCacheDeleteParams;
    export import SmartTieredCacheEditParams = SmartTieredCacheAPI.SmartTieredCacheEditParams;
    export import SmartTieredCacheGetParams = SmartTieredCacheAPI.SmartTieredCacheGetParams;
    export import Variants = VariantsAPI.Variants;
    export import CacheVariant = VariantsAPI.CacheVariant;
    export import CacheVariantIdentifier = VariantsAPI.CacheVariantIdentifier;
    export import VariantEditResponse = VariantsAPI.VariantEditResponse;
    export import VariantGetResponse = VariantsAPI.VariantGetResponse;
    export import VariantDeleteParams = VariantsAPI.VariantDeleteParams;
    export import VariantEditParams = VariantsAPI.VariantEditParams;
    export import VariantGetParams = VariantsAPI.VariantGetParams;
    export import RegionalTieredCacheResource = RegionalTieredCacheAPI.RegionalTieredCacheResource;
    export import RegionalTieredCache = RegionalTieredCacheAPI.RegionalTieredCache;
    export import RegionalTieredCacheEditResponse = RegionalTieredCacheAPI.RegionalTieredCacheEditResponse;
    export import RegionalTieredCacheGetResponse = RegionalTieredCacheAPI.RegionalTieredCacheGetResponse;
    export import RegionalTieredCacheEditParams = RegionalTieredCacheAPI.RegionalTieredCacheEditParams;
    export import RegionalTieredCacheGetParams = RegionalTieredCacheAPI.RegionalTieredCacheGetParams;
}
//# sourceMappingURL=cache.d.ts.map