CyOpticsRules.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<#
.SYNOPSIS
    Gets a list of all detection rules from the console.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
#>

function Get-CyDetectionRuleList {
    Param (
        [parameter(Mandatory=$false)]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle
    )

    Read-CyData -API $API -Uri "$($API.BaseUrl)/rules/v2"
}

<#
.SYNOPSIS
    Retrieves the given detection rule native JSON structure
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Exception
    The detection rule to retrieve.
#>

function Get-CyDetectionRuleDetail {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [object[]]$Rule
        )

    Process {
        Invoke-CyRestMethod -API $API -Method GET -Uri  "$($API.BaseUrl)/rules/v2/$($Rule.id)" | Convert-CyObject
    }
}


<#
.SYNOPSIS
    Gets a list of all detection rules from the console.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
#>

function Get-CyDetectionExceptionList {
    Param (
        [parameter(Mandatory=$false)]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle
    )

    Read-CyData -API $API -Uri "$($API.BaseUrl)/exceptions/v2"
}

<#
.SYNOPSIS
    Retrieves the given detection exception native JSON structure
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Exception
    The exception to retrieve.
#>

function Get-CyDetectionExceptionDetail {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [object[]]$Exception
        )

    Process {
        Invoke-CyRestMethod -API $API -Method GET -Uri  "$($API.BaseUrl)/exceptions/v2/$($Exception.id)" | Convert-CyObject
    }
}