Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • get_miscon_by_computer

  • get_misconfigurations_start to set a filter and get a token for following calls to get_misconfigurations_next

  • get_miscon_computers_start to set a filter and get a token for following calls to get_miscon_computers_next

  • add_to_group - to add computers to your custom group

Info

All methods are POST.

API Keys

All HTTPS requests for REST API functions must include the x-api-key parameter in the request header, as illustrated in the examples below.

On-Prem Customers:

To generate an API key in the GYTPOL UI, navigate to the

Note

The on-prem server API permits only 100 reads per minute. To prevent surpassing this limit, it's recommended to integrate a timeout or pause within the PS1 script between loops.

For example:

Code Block
languagepowershell
# Your existing code here

# Add a pause of 2 seconds (adjust as needed) between each iteration
Start-Sleep -Seconds 2

API Keys

All HTTPS requests for REST API functions must include the x-api-key parameter in the request header, as illustrated in the examples below.

SaaS customers are advised to reach out to their customer success manager to obtain the necessary x-api-key.

On-Prem Customers:

To generate an API key in the GYTPOL UI, navigate to the gear icon > Settings > GYTPOL API Keys. To create a new key, click the + (Plus) icon and assign a name that corresponds to the system. The key will expire after 1 year by default.

SaaS customers are advised to reach out to their customer success manager to obtain the necessary x-api-key.

Image Removed

Image Removed

API Port

For On-Prem customers, the default port for API access is 9191. If you wish to use a different port, you can make the adjustment by modifying the port in the file located at c:\gytpol\data\webserv_config.json.

After changing the port, be sure to restart the gytpol Web UI service to apply the modifications.

Image Removed

For SaaS customers, there is no need to specify a port, as the URL utilizes port 443a new key, click the + (Plus) icon and assign a name that corresponds to the system. The key will expire after 1 year by default.

...

Image Added

API Port

For On-Prem customers, the default port for API access is 9191. If you wish to use a different port, you can make the adjustment by modifying the port in the file located at c:\gytpol\data\webserv_config.json.

After changing the port, be sure to restart the gytpol Web UI service to apply the modifications.

Image Added

For SaaS customers, there is no need to specify a port, as the URL utilizes port 443.

Base URL

The Base URL variable in both the scripts and the examples provided below should be set to your GYTPOL URL.

For on-premises customers, it's necessary to append the port after the GYTPOL server URL, like so: https://gytpol.domain.local:9191/gytpolapi/v2.0/<function-name>.

However, SaaS customers can simply utilize the URL of their tenant without the port: https://gytpol.eu.cloud.gytpol.com/gytpolapi/v2.0/<function-name>.

get_miscon_by_computer

This REST API function returns misconfigurations given a computer name and optionally Windows domain name.

...

computers

object array

latestHostReportingDt

datetime

Latest date and time the computer reported to Gytpol

latestScanDt

datetime

Gytpol client sensor scans computers for misconfigurations and sends the report to Gytpol backend. This is the date and time of the latest misconfiguration scan reported for this computer.

computer

string

Computer name

computerOu

string

Name of organizational unit define on this computer

domainName

string

For windows computers, Windows domain name

clientVer

string

Gytpol client sensor version currently installed on this computer

ipAddress

string

Computer’s IP address

os

string

Computer’s operating system

isVdi

bool

Is this computer a VDI

isServer

bool

Is this computer a server

isDC

bool

Is this computer a domain controller

miscon

object array

Array of misconfigurations reported for this computer

topicCode

string

user

string

Username logged into the computer when this misconfiguration had been found

severity

string

Specifies minimal severity of returned misconfigurations. Supported values are:

Low

Medium

High

addInfo

string

Additional information describing this misconfiguration (this is json string) with \ before “ in order to prevent breaking the structure of the response json

param

string

Parameter providing more details for the misconfiguration

paramExtra

string

Parameter providing even more details for the misconfiguration

isRemediable

bool

Is this misconfiguration remediable

isMuted

bool

Is this misconfiguration muted by one of the mute rules

mutedByRuleId

number

The Id of the mute rule that muted this misconfiguration

hostReportingDt

datetime

Datetime when computer reported this misconfiguration to Gytpol backend

scanTimeDt

datetime

Datetime when Gytpol client sensor installed on the computer found this misconfiguration

...

Code Block
languagepowershell
$headers = @{
    "x-api-key" = "{API KEY}"
    "Content-Type" = "application/json"
}
$body = "{}"
$outputData = @()

$response = Invoke-RestMethod -Uri 'https://{BASE URL}/gytpolapi/v2.0/get_misconfigurations_start' -Method 'POST' -Headers $headers -Body $body

do {
    # Convert response to JSON and output
    $response | ConvertTo-Json -Depth 3

    # Accumulate data for each iteration
    $outputData += $response

    # Prepare next request body
    $body = @{ token = $response.token } | ConvertTo-Json } | ConvertTo-Json
    
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    [System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}
    
    # Make next request
    $response = Invoke-RestMethod -Uri 'https://{BASE URL}/gytpolapi/v2.0/get_misconfigurations_next' -Method 'POST' -Headers $headers -Body $body
} until ($response.computers.Count -eq 0 -or $iteration -eq 5)

# Export all the data to a JSON file
$outputData | ConvertTo-Json | Set-Content -Path "C:\path\to\output_data.json"

...

computers

object array

Keep calling to get_miscon_computers_next until empty computers array is returned, e.g. computers[]

latestHostReportingDt

datetime

Latest date and time the computer reported to Gytpol

latestScanDt

datetime

Gytpol client sensor scans computers for misconfigurations and sends the report to Gytpol backend. This is the date and time of the latest misconfiguration scan reported for this computer.

computer

string

Computer name

computerOu

string

Name of organizational unit define on this computer

domainName

string

For windows computers, Windows domain name

clientVer

string

Gytpol client sensor version currently installed on this computer

ipAddress

string

Computer’s IP address

os

string

Computer’s operating system

isVdi

bool

Is this computer a VDI

isServer

bool

Is this computer a server

isDC

bool

Is this computer a domain controller

token

string

Encrypted string to use for following calls to the get_misconfigurations_next function

...

Code Block
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("x-api-key", "{x-api-key}")
$headers.Add("Content-Type", "application/json")

# Ensure the computer group is created in the UI with at least one device
# Replace {GROUP} with the actual group name, i.e SERVERS
$groupName = "{GROUP}"

# Read computer names from CSV file without headers
$computers = Get-Content -Path "c:\path\to\computers.csv" | Select-Object -Skip 1

# Loop through each computer and add it to the group
foreach ($line in $computers) {
    # Split the line by commas and take the first part as the computer name
    $computerName = $line.Split(',')[0].Trim()

    # Create the body for the API request
    $body = @{
        groupName = $groupName
        computerName = $computerName
    } | ConvertTo-Json
    
    # Send the API request
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    [System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}
    
    $response = Invoke-RestMethod -Uri "https://{BASE-URL}/gytpolapi/v2.0/add_to_group" -Method 'POST' -Headers $headers -Body $body
    $response | ConvertTo-Json
    
    # Optional: Add a 2-second pause between each iteration. Remove the comment if needed.
    # Start-Sleep -Seconds 2
}

Note: Change BASE-URL to your base URL. Change x-api-key to your API key.

...