cloudflare/resources/intel/domains/bulks.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as BulksAPI from 'cloudflare/resources/intel/domains/bulks';
export declare class Bulks extends APIResource {
    /**
     * Get Multiple Domain Details
     */
    get(params: BulkGetParams, options?: Core.RequestOptions): Core.APIPromise<BulkGetResponse | null>;
}
export type BulkGetResponse = Array<BulkGetResponse.BulkGetResponseItem>;
export declare namespace BulkGetResponse {
    interface BulkGetResponseItem {
        /**
         * Additional information related to the host name.
         */
        additional_information?: BulkGetResponseItem.AdditionalInformation;
        /**
         * Application that the hostname belongs to.
         */
        application?: BulkGetResponseItem.Application;
        /**
         * Current content categories.
         */
        content_categories?: Array<unknown>;
        domain?: string;
        inherited_content_categories?: Array<BulkGetResponseItem.InheritedContentCategory>;
        /**
         * Domain from which `inherited_content_categories` and `inherited_risk_types` are
         * inherited, if applicable.
         */
        inherited_from?: string;
        inherited_risk_types?: Array<BulkGetResponseItem.InheritedRiskType>;
        /**
         * Global Cloudflare 100k ranking for the last 30 days, if available for the
         * hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.
         */
        popularity_rank?: number;
        /**
         * Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest
         * risk).
         */
        risk_score?: number;
        risk_types?: Array<unknown>;
    }
    namespace BulkGetResponseItem {
        /**
         * Additional information related to the host name.
         */
        interface AdditionalInformation {
            /**
             * Suspected DGA malware family.
             */
            suspected_malware_family?: string;
        }
        /**
         * Application that the hostname belongs to.
         */
        interface Application {
            id?: number;
            name?: string;
        }
        interface InheritedContentCategory {
            id?: number;
            name?: string;
            super_category_id?: number;
        }
        interface InheritedRiskType {
            id?: number;
            name?: string;
            super_category_id?: number;
        }
    }
}
export interface BulkGetParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Query param: Accepts multiple values, i.e.
     * `?domain=cloudflare.com&domain=example.com`.
     */
    domain?: unknown;
}
export declare namespace Bulks {
    export import BulkGetResponse = BulksAPI.BulkGetResponse;
    export import BulkGetParams = BulksAPI.BulkGetParams;
}
//# sourceMappingURL=bulks.d.ts.map