Skip to content

Set-URLScanConfiguration

SYNOPSIS

Used to set URLScan.io specific configuration

SYNTAX

Set-URLScanConfiguration [[-APIKey] <String>] [[-DefaultPageLimit] <String>] [[-ScreenshotPath] <String>]
 [-Persist]

DESCRIPTION

This function is used to set URLScan.io specific configuration, such as the BloxOne CSP API Key, Region/URL and enabling/disabling development or debug mode

EXAMPLES

EXAMPLE 1

Set-URLScanConfiguration -APIKey '<APIKey>' -Persist

URLScan.io key has been stored permanently for user on MAC-DSD984HG

EXAMPLE 2

Set-ibPSConfiguration -DefaultPageLimit 1000

PARAMETERS

-APIKey

Use this parameter to save the API Key for URLScan.io. If an API Key is not saved, you will be bound by the rate limits of a free user.

Type: String
Parameter Sets: (All)
Aliases:

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

-DefaultPageLimit

Optionally set the default page size to be returned when performing queries to URLScan.io. This is set to 100 by default, which aligns with the Free Tier. If you have an account or subscription with URLScan.io, you can specify this value in line with your account limits.

Type: String
Parameter Sets: (All)
Aliases:

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

-ScreenshotPath

Optionally configure a default screenshot path for when using Get-URLScanScreenshot & Get-URLScanLiveshot functions.

Type: String
Parameter Sets: (All)
Aliases:

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

-Persist

Setting the -Persist parameter will save the configuration permanently for your user on this device. Without using this switch, the settings will only be saved for the duration of the PowerShell session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

INPUTS

OUTPUTS

NOTES