@iocium/urlscan - v0.0.0
    Preparing search index...

    Interface ScanPayload

    Represents the payload for a scan request.

    interface ScanPayload {
        country?: string;
        customagent?: string;
        overrideSafety?: string | boolean;
        referer?: string;
        tags?: string[];
        url: string;
        visibility?: "private" | "public" | "unlisted";
    }
    Index

    Properties

    country? customagent? overrideSafety? referer? tags? url visibility?

    Properties

    country?: string

    Optional 2-letter ISO-3166-1 alpha-2 country code to specify the location for the scan.

    customagent?: string

    Optional custom user agent string to use for the scan.

    overrideSafety?: string | boolean

    Optional safety override flag. It can be a boolean or a string representation of a boolean ("true"/"false").

    referer?: string

    Optional referer URL to include in the scan request.

    tags?: string[]

    Optional array of tags associated with the scan.

    url: string

    The URL to be scanned.

    visibility?: "private" | "public" | "unlisted"

    Optional visibility status for the scan. Can be 'public', 'unlisted', or 'private'.

    Settings

    Member Visibility

    On This Page

    Properties