Skip to content
This repository was archived by the owner on Dec 17, 2021. It is now read-only.

Commit 54af44e

Browse files
sysgoblinsysgoblin
committed
documentation
1 parent 64ce509 commit 54af44e

File tree

6 files changed

+206
-19
lines changed

6 files changed

+206
-19
lines changed

‎docs/en-US/Get-UrlScanioDOM.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
external help file: PSUrlScanio-help.xml
3+
Module Name: PSUrlScanio
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-UrlScanioDOM
9+
10+
## SYNOPSIS
11+
Create or update the urlscan.io config file.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-UrlScanioDOM [-id] <String> [-Path <String>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Returns raw DOM of the specified scan id by urlscan.io.
21+
If no path is specified DOM will write to console.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
Get-UrlScanioDOM -id b14db0aa-013c-4aa9-ad5a-ec947a2278c7 -Path c:\temp
28+
```
29+
30+
Saves output of specified id as C:\temp\b14db0aa-013c-4aa9-ad5a-ec947a2278c7.txt
31+
32+
## PARAMETERS
33+
34+
### -id
35+
Unique ID of scan to return raw DOM of.
36+
37+
```yaml
38+
Type: String
39+
Parameter Sets: (All)
40+
Aliases:
41+
42+
Required: True
43+
Position: 1
44+
Default value: None
45+
Accept pipeline input: True (ByPropertyName, ByValue)
46+
Accept wildcard characters: False
47+
```
48+
49+
### -Path
50+
Path to save copy of DOM as txt file.
51+
52+
```yaml
53+
Type: String
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: False
58+
Position: Named
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### CommonParameters
65+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
66+
67+
## INPUTS
68+
69+
## OUTPUTS
70+
71+
## NOTES
72+
73+
## RELATED LINKS

‎docs/en-US/Get-UrlScanioLiveshot.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-UrlScanioLiveshot
99

1010
## SYNOPSIS
11-
Get live screenshot of specified URL.
11+
Create or update the urlscan.io config file.
1212

1313
## SYNTAX
1414

‎docs/en-US/Get-UrlScanioScan.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,21 @@ Get urlscan.io scan results.
1212

1313
## SYNTAX
1414

15+
### All (Default)
16+
```
17+
Get-UrlScanioScan [-id] <String[]> [<CommonParameters>]
18+
```
19+
20+
### data
1521
```
1622
Get-UrlScanioScan [-id] <String[]> [-DataType <String>] [-IncludeTaskDetails] [<CommonParameters>]
1723
```
1824

25+
### similar
26+
```
27+
Get-UrlScanioScan [-id] <String[]> [-SimilarDomains] [<CommonParameters>]
28+
```
29+
1930
## DESCRIPTION
2031
Get urlscan.io scan results for the provided uuid.
2132
Returns results as an object by default.
@@ -51,7 +62,7 @@ Data type to return. Provides quick access to specific sub-sets of data for inte
5162
5263
```yaml
5364
Type: String
54-
Parameter Sets: (All)
65+
Parameter Sets: data
5566
Aliases:
5667

5768
Required: False
@@ -66,7 +77,22 @@ Accept wildcard characters: False
6677
6778
```yaml
6879
Type: SwitchParameter
69-
Parameter Sets: (All)
80+
Parameter Sets: data
81+
Aliases:
82+
83+
Required: False
84+
Position: Named
85+
Default value: False
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### -SimilarDomains
91+
List structurally similar domains.
92+
93+
```yaml
94+
Type: SwitchParameter
95+
Parameter Sets: similar
7096
Aliases:
7197

7298
Required: False

‎docs/en-US/Get-UrlScanioScreenshot.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file: PSUrlScanio-help.xml
3+
Module Name: PSUrlScanio
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-UrlScanioScreenshot
9+
10+
## SYNOPSIS
11+
Get copy of last screenshot taken by urlscan.io
12+
13+
## SYNTAX
14+
15+
```
16+
Get-UrlScanioScreenshot [-id] <String> -Path <String> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Retreives copy of screenshot present on urlscan.io result page and saves to the specified location.
21+
22+
## EXAMPLES
23+
24+
### EXAMPLE 1
25+
```
26+
Get-UrlScanioScreenshot -id b14db0aa-013c-4aa9-ad5a-ec947a2278c7 -Path c:\temp
27+
```
28+
29+
Saves screenshot of specified id as C:\temp\b14db0aa-013c-4aa9-ad5a-ec947a2278c7.png
30+
31+
## PARAMETERS
32+
33+
### -id
34+
Unique ID of scan to retrieve the screenshot of.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases: uuid, _id
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: True (ByPropertyName, ByValue)
45+
Accept wildcard characters: False
46+
```
47+
48+
### -Path
49+
Path to save the screenshot file to.
50+
51+
```yaml
52+
Type: String
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: True
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
## OUTPUTS
69+
70+
## NOTES
71+
72+
## RELATED LINKS

‎docs/en-US/PSUrlScanio.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
---
22
Module Name: PSUrlScanio
33
Module Guid: 00ae67df-b1ae-400c-bcb4-dad7feba9db0
4-
Download Help Link: {{ n/a }}
5-
Help Version: {{ 0.0.0.1 }}
4+
Download Help Link: {{ null }}
5+
Help Version: {{ 0.0.1.0 }}
66
Locale: en-US
77
---
88

99
# PSUrlScanio Module
1010
## Description
11-
Powershell module for interacting with the urlscan.io api.
11+
Powershell module for utilising the urlscan.io api.
1212

1313
## PSUrlScanio Cmdlets
1414
### [Connect-UrlScanio](Connect-UrlScanio.md)
15-
Create or update the urlscan.io config file which contains the API key used within the PSUrlScanio module.
15+
Create or update the urlscan.io config file.
16+
17+
### [Get-UrlScanioDOM](Get-UrlScanioDOM.md)
18+
Create or update the urlscan.io config file.
19+
20+
### [Get-UrlScanioLiveshot](Get-UrlScanioLiveshot.md)
21+
Create or update the urlscan.io config file.
1622

1723
### [Get-UrlScanioScan](Get-UrlScanioScan.md)
18-
Get urlscan.io scan results for the provided uuid.
24+
Get urlscan.io scan results.
25+
26+
### [Get-UrlScanioScreenshot](Get-UrlScanioScreenshot.md)
27+
Get copy of last screenshot taken by urlscan.io
1928

2029
### [Search-UrlScanio](Search-UrlScanio.md)
21-
Search urlscan.io using the provided parameters or providing a filter using Elasticsearch Query String syntax
22-
(https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
30+
Search urlscan.io results.
2331

2432
### [Start-UrlScanioScan](Start-UrlScanioScan.md)
25-
Start-UrlScanioScan triggers a scan of the specified URL.
33+
Start scan of URL on urlscan.io

‎docs/en-US/README.md‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
---
22
Module Name: PSUrlScanio
33
Module Guid: 00ae67df-b1ae-400c-bcb4-dad7feba9db0
4-
Download Help Link: {{ n/a }}
5-
Help Version: {{ 0.0.0.1 }}
4+
Download Help Link: {{ null }}
5+
Help Version: {{ 0.0.1.0 }}
66
Locale: en-US
77
---
88

99
# PSUrlScanio Module
1010
## Description
11-
Powershell module for interacting with the urlscan.io api.
11+
Powershell module for utilising the urlscan.io api.
1212

1313
## PSUrlScanio Cmdlets
1414
### [Connect-UrlScanio](Connect-UrlScanio.md)
15-
Create or update the urlscan.io config file which contains the API key used within the PSUrlScanio module.
15+
Create or update the urlscan.io config file.
16+
17+
### [Get-UrlScanioDOM](Get-UrlScanioDOM.md)
18+
Create or update the urlscan.io config file.
19+
20+
### [Get-UrlScanioLiveshot](Get-UrlScanioLiveshot.md)
21+
Create or update the urlscan.io config file.
1622

1723
### [Get-UrlScanioScan](Get-UrlScanioScan.md)
18-
Get urlscan.io scan results for the provided uuid.
24+
Get urlscan.io scan results.
25+
26+
### [Get-UrlScanioScreenshot](Get-UrlScanioScreenshot.md)
27+
Get copy of last screenshot taken by urlscan.io
1928

2029
### [Search-UrlScanio](Search-UrlScanio.md)
21-
Search urlscan.io using the provided parameters or providing a filter using Elasticsearch Query String syntax
22-
(https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
30+
Search urlscan.io results.
2331

2432
### [Start-UrlScanioScan](Start-UrlScanioScan.md)
25-
Start-UrlScanioScan triggers a scan of the specified URL.
33+
Start scan of URL on urlscan.io

0 commit comments

Comments
 (0)