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

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as DomainsAPI from 'cloudflare/resources/intel/domains/domains';
import * as BulksAPI from 'cloudflare/resources/intel/domains/bulks';
export declare class Domains extends APIResource {
    bulks: BulksAPI.Bulks;
    /**
     * Get Domain Details
     */
    get(params: DomainGetParams, options?: Core.RequestOptions): Core.APIPromise<IntelDomain>;
}
export interface IntelDomain {
    /**
     * Additional information related to the host name.
     */
    additional_information?: IntelDomain.AdditionalInformation;
    /**
     * Application that the hostname belongs to.
     */
    application?: IntelDomain.Application;
    /**
     * Current content categories.
     */
    content_categories?: Array<unknown>;
    domain?: string;
    inherited_content_categories?: Array<IntelDomain.InheritedContentCategory>;
    /**
     * Domain from which `inherited_content_categories` and `inherited_risk_types` are
     * inherited, if applicable.
     */
    inherited_from?: string;
    inherited_risk_types?: Array<IntelDomain.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;
    /**
     * Specifies a list of references to one or more IP addresses or domain names that
     * the domain name currently resolves to.
     */
    resolves_to_refs?: Array<IntelDomain.ResolvesToRef>;
    /**
     * Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest
     * risk).
     */
    risk_score?: number;
    risk_types?: Array<unknown>;
}
export declare namespace IntelDomain {
    /**
     * 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;
    }
    interface ResolvesToRef {
        /**
         * STIX 2.1 identifier:
         * https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c
         */
        id?: string;
        /**
         * IP address or domain name.
         */
        value?: string;
    }
}
export interface DomainGetParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Query param:
     */
    domain?: string;
}
export declare namespace Domains {
    export import IntelDomain = DomainsAPI.IntelDomain;
    export import DomainGetParams = DomainsAPI.DomainGetParams;
    export import Bulks = BulksAPI.Bulks;
    export import BulkGetResponse = BulksAPI.BulkGetResponse;
    export import BulkGetParams = BulksAPI.BulkGetParams;
}
//# sourceMappingURL=domains.d.ts.map