cloudflare/resources/custom-hostnames/quota.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseQuota extends APIResource {
    static readonly _key: readonly ['customHostnames', 'quota'];
    /**
     * Returns custom hostname quota usage for a zone. The allocated quota is a soft
     * limit; creating custom hostnames after usage exceeds this limit can still
     * succeed until the hard cap is reached. Use the exceeded and hard_cap fields to
     * track when usage is above the soft limit and when new custom hostname creation
     * will be rejected.
     *
     * @example
     * ```ts
     * const quota = await client.customHostnames.quota.get({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    get(params: QuotaGetParams, options?: RequestOptions): APIPromise<QuotaGetResponse>;
}
export declare class Quota extends BaseQuota {
}
export interface QuotaGetResponse {
    /**
     * The allocated custom hostname quota.
     */
    allocated: number;
    /**
     * Whether the current usage has exceeded the allocated quota.
     */
    exceeded: boolean;
    /**
     * The maximum number of custom hostnames allowed before create requests are
     * rejected.
     */
    hard_cap: number;
    /**
     * The number of custom hostnames currently in use.
     */
    used: number;
}
export interface QuotaGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace Quota {
    export { type QuotaGetResponse as QuotaGetResponse, type QuotaGetParams as QuotaGetParams };
}
//# sourceMappingURL=quota.d.mts.map