cloudflare/resources/page-shield/connections.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as ConnectionsAPI from 'cloudflare/resources/page-shield/connections';
import { SinglePage } from 'cloudflare/pagination';
export declare class Connections extends APIResource {
    /**
     * Lists all connections detected by Page Shield.
     */
    list(params: ConnectionListParams, options?: Core.RequestOptions): Core.PagePromise<PageShieldConnectionsSinglePage, PageShieldConnection>;
    /**
     * Fetches a connection detected by Page Shield by connection ID.
     */
    get(connectionId: string, params: ConnectionGetParams, options?: Core.RequestOptions): Core.APIPromise<PageShieldConnection>;
}
export declare class PageShieldConnectionsSinglePage extends SinglePage<PageShieldConnection> {
}
export interface PageShieldConnection {
    id?: string;
    added_at?: string;
    domain_reported_malicious?: boolean;
    first_page_url?: string;
    first_seen_at?: string;
    host?: string;
    last_seen_at?: string;
    page_urls?: Array<string>;
    url?: string;
    url_contains_cdn_cgi_path?: boolean;
}
export interface ConnectionListParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Query param: The direction used to sort returned connections.
     */
    direction?: 'asc' | 'desc';
    /**
     * Query param: When true, excludes connections seen in a `/cdn-cgi` path from the
     * returned connections. The default value is true.
     */
    exclude_cdn_cgi?: boolean;
    /**
     * Query param: Excludes connections whose URL contains one of the URL-encoded URLs
     * separated by commas.
     */
    exclude_urls?: string;
    /**
     * Query param: Export the list of connections as a file. Cannot be used with
     * per_page or page options.
     */
    export?: 'csv';
    /**
     * Query param: Includes connections that match one or more URL-encoded hostnames
     * separated by commas.
     *
     * Wildcards are supported at the start and end of each hostname to support starts
     * with, ends with and contains. If no wildcards are used, results will be filtered
     * by exact match
     */
    hosts?: string;
    /**
     * Query param: The field used to sort returned connections.
     */
    order_by?: 'first_seen_at' | 'last_seen_at';
    /**
     * Query param: The current page number of the paginated results.
     *
     * We additionally support a special value "all". When "all" is used, the API will
     * return all the connections with the applied filters in a single page.
     * Additionally, when using this value, the API will not return the categorisation
     * data for the URL and domain of the connections. This feature is best-effort and
     * it may only work for zones with a low number of connections
     */
    page?: string;
    /**
     * Query param: Includes connections that match one or more page URLs (separated by
     * commas) where they were last seen
     *
     * Wildcards are supported at the start and end of each page URL to support starts
     * with, ends with and contains. If no wildcards are used, results will be filtered
     * by exact match
     */
    page_url?: string;
    /**
     * Query param: The number of results per page.
     */
    per_page?: number;
    /**
     * Query param: When true, malicious connections appear first in the returned
     * connections.
     */
    prioritize_malicious?: boolean;
    /**
     * Query param: Filters the returned connections using a comma-separated list of
     * connection statuses. Accepted values: `active`, `infrequent`, and `inactive`.
     * The default value is `active`.
     */
    status?: string;
    /**
     * Query param: Includes connections whose URL contain one or more URL-encoded URLs
     * separated by commas.
     */
    urls?: string;
}
export interface ConnectionGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace Connections {
    export import PageShieldConnection = ConnectionsAPI.PageShieldConnection;
    export import PageShieldConnectionsSinglePage = ConnectionsAPI.PageShieldConnectionsSinglePage;
    export import ConnectionListParams = ConnectionsAPI.ConnectionListParams;
    export import ConnectionGetParams = ConnectionsAPI.ConnectionGetParams;
}
//# sourceMappingURL=connections.d.ts.map