cloudflare/resources/dns/usage/zone.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseZone extends APIResource {
    static readonly _key: readonly ['dns', 'usage', 'zone'];
    /**
     * Get the current DNS record usage for a zone, including the number of records and
     * the quota limit.
     *
     * @example
     * ```ts
     * const zone = await client.dns.usage.zone.get({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    get(params: ZoneGetParams, options?: RequestOptions): APIPromise<ZoneGetResponse>;
}
export declare class Zone extends BaseZone {
}
export interface ZoneGetResponse {
    /**
     * Maximum number of DNS records allowed for the zone. Null if using account-level
     * quota.
     */
    record_quota: number | null;
    /**
     * Current number of DNS records in the zone.
     */
    record_usage: number;
}
export interface ZoneGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace Zone {
    export { type ZoneGetResponse as ZoneGetResponse, type ZoneGetParams as ZoneGetParams };
}
//# sourceMappingURL=zone.d.ts.map