cloudflare/resources/spectrum/protocols.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { PagePromise, SinglePage } from "../../core/pagination.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseProtocols extends APIResource {
    static readonly _key: readonly ['spectrum', 'protocols'];
    /**
     * Retrieves a list of Spectrum application protocols available for a zone.
     */
    list(params: ProtocolListParams, options?: RequestOptions): PagePromise<ProtocolListResponsesSinglePage, ProtocolListResponse>;
}
export declare class Protocols extends BaseProtocols {
}
export type ProtocolListResponsesSinglePage = SinglePage<ProtocolListResponse>;
export interface ProtocolListResponse {
    /**
     * The full name of the application protocol.
     */
    description: string;
    /**
     * The short name of the application protocol.
     */
    name: string;
    /**
     * The available listening ports for the given protocol.
     */
    ports: Array<number>;
    /**
     * The transport layer protocol used by the application protocol
     */
    transport: string;
}
export interface ProtocolListParams {
    /**
     * Zone identifier.
     */
    zone_id: string;
}
export declare namespace Protocols {
    export { type ProtocolListResponse as ProtocolListResponse, type ProtocolListResponsesSinglePage as ProtocolListResponsesSinglePage, type ProtocolListParams as ProtocolListParams, };
}
//# sourceMappingURL=protocols.d.ts.map