Skip to content

Start-B1DossierLookup

SYNOPSIS

Performs a single lookup against the BloxOne Threat Defense Dossier

SYNTAX

Start-B1DossierLookup [-Type] <String> [-Value] <String> [[-Source] <String[]>] [-Wait] [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

This function is used to perform a single lookup against the BloxOne Threat Defense Dossier

EXAMPLES

EXAMPLE 1

Start-B1DossierLookup -Type ip -Value 1.1.1.1

EXAMPLE 2

Start-B1DossierLookup -Type host -Value eicar.co

status  job_id                               job
------  ------                               ---
pending 123456788-123d-4565-6452-05fgdgv54t4fvswe @{id=123456788-123d-4565-6452-05fgdgv54t4fvswe; state=created; status=pending; create_ts=1709744367885; create_time=2024-03-06T16:59:27.88511568Z; start_ts=1709744367885; start_time=2024-03-06T16:59:27.88511568Z; request_ttl=0; result_ttl=3600; p

PARAMETERS

-Type

The indicator type to search on

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The indicator value to search on

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Source

The sources to query. Multiple sources can be specified, if no source is specified, the call will search on all available sources. A list of supported sources can be obtained by using the Get-B1DossierSupportedSources cmdlet

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Wait

If this switch is set, the API call will wait for job completion before returning

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to Low.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES