cloudflare/resources/zones/holds.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as HoldsAPI from 'cloudflare/resources/zones/holds';
export declare class Holds extends APIResource {
    /**
     * Enforce a zone hold on the zone, blocking the creation and activation of zones
     * with this zone's hostname.
     */
    create(params: HoldCreateParams, options?: Core.RequestOptions): Core.APIPromise<HoldCreateResponse>;
    /**
     * Stop enforcement of a zone hold on the zone, permanently or temporarily,
     * allowing the creation and activation of zones with this zone's hostname.
     */
    delete(params: HoldDeleteParams, options?: Core.RequestOptions): Core.APIPromise<HoldDeleteResponse>;
    /**
     * Retrieve whether the zone is subject to a zone hold, and metadata about the
     * hold.
     */
    get(params: HoldGetParams, options?: Core.RequestOptions): Core.APIPromise<HoldGetResponse>;
}
export interface HoldCreateResponse {
    hold?: boolean;
    hold_after?: string;
    include_subdomains?: string;
}
export interface HoldDeleteResponse {
    hold?: boolean;
    hold_after?: string;
    include_subdomains?: string;
}
export interface HoldGetResponse {
    hold?: boolean;
    hold_after?: string;
    include_subdomains?: string;
}
export interface HoldCreateParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Query param: If provided, the zone hold will extend to block any subdomain of
     * the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold
     * on a zone with the hostname 'example.com' and include_subdomains=true will block
     * 'example.com', 'staging.example.com', 'api.staging.example.com', etc.
     */
    include_subdomains?: boolean;
}
export interface HoldDeleteParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Query param: If `hold_after` is provided, the hold will be temporarily disabled,
     * then automatically re-enabled by the system at the time specified in this
     * RFC3339-formatted timestamp. Otherwise, the hold will be disabled indefinitely.
     */
    hold_after?: string;
}
export interface HoldGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace Holds {
    export import HoldCreateResponse = HoldsAPI.HoldCreateResponse;
    export import HoldDeleteResponse = HoldsAPI.HoldDeleteResponse;
    export import HoldGetResponse = HoldsAPI.HoldGetResponse;
    export import HoldCreateParams = HoldsAPI.HoldCreateParams;
    export import HoldDeleteParams = HoldsAPI.HoldDeleteParams;
    export import HoldGetParams = HoldsAPI.HoldGetParams;
}
//# sourceMappingURL=holds.d.ts.map