cloudflare
Version:
The official TypeScript library for the Cloudflare API
42 lines • 1.69 kB
TypeScript
import { APIResource } from "../../../core/resource.js";
import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../core/pagination.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseHosts extends APIResource {
static readonly _key: readonly ['apiGateway', 'userSchemas', 'hosts'];
/**
* Lists all unique hosts found in uploaded OpenAPI schemas for the zone. Useful
* for understanding which domains have schema coverage. Deprecated; use
* `/zones/{zone_id}/schema_validation/schemas/hosts` instead.
*
* @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
*/
list(params: HostListParams, options?: RequestOptions): PagePromise<HostListResponsesV4PagePaginationArray, HostListResponse>;
}
export declare class Hosts extends BaseHosts {
}
export type HostListResponsesV4PagePaginationArray = V4PagePaginationArray<HostListResponse>;
export interface HostListResponse {
created_at: string;
/**
* Hosts serving the schema, e.g zone.host.com
*/
hosts: Array<string>;
/**
* Name of the schema
*/
name: string;
/**
* UUID.
*/
schema_id: string;
}
export interface HostListParams extends V4PagePaginationArrayParams {
/**
* Path param: Identifier.
*/
zone_id: string;
}
export declare namespace Hosts {
export { type HostListResponse as HostListResponse, type HostListResponsesV4PagePaginationArray as HostListResponsesV4PagePaginationArray, type HostListParams as HostListParams, };
}
//# sourceMappingURL=hosts.d.ts.map