Skip to content

QueryLogApi.md

Latest commit

 

History

History
130 lines (97 loc) · 5.34 KB

QueryLogApi.md

File metadata and controls

130 lines (97 loc) · 5.34 KB

PSAdGuardDNS.PSAdGuardDNS\Api.QueryLogApi

All URIs are relative to https://api.adguard-dns.io

Method HTTP request Description
Clear-QueryLog DELETE /oapi/v1/query_log Clears query log
Get-QueryLog GET /oapi/v1/query_log Gets query log

Clear-QueryLog

void Clear-QueryLog

Clears query log

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: ApiKey
$Configuration.ApiKey.Authorization = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.Authorization = "Bearer"



# Clears query log
try {
    $Result = Clear-QueryLog
} catch {
    Write-Host ("Exception occurred when calling Clear-QueryLog: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ApiKey, AuthToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-QueryLog

QueryLogResponse Get-QueryLog
        [-TimeFromMillis]
        [-TimeToMillis]
        [-Devices] <String[]>
        [-Countries] <String[]>
        [-Companies] <String[]>
        [-Statuses] <PSCustomObject[]>
        [-Categories] <PSCustomObject[]>
        [-Search]
        [-Limit] <System.Nullable[Int32]>
        [-Cursor]

Gets query log

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: ApiKey
$Configuration.ApiKey.Authorization = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.Authorization = "Bearer"


$TimeFromMillis = 789 # Int64 | Time from in milliseconds (inclusive)
$TimeToMillis = 789 # Int64 | Time to in milliseconds (inclusive)
$Devices = "MyDevices" # String[] | Filter by devices (optional)
$Countries = "MyCountries" # String[] | Filter by countries (optional)
$Companies = "MyCompanies" # String[] | Filter by companies (optional)
$Statuses = "UNKNOWN" # FilteringActionStatus[] | Filter by statuses (optional)
$Categories = "ADS" # CategoryType[] | Filter by categories (optional)
$Search = "MySearch" # String | Filter by domain name (optional)
$Limit = 56 # Int32 | Limit the number of records to be returned (optional) (default to 20)
$Cursor = "MyCursor" # String | Pagination cursor. Use cursor from response to paginate through the pages. (optional)

# Gets query log
try {
    $Result = Get-QueryLog -TimeFromMillis $TimeFromMillis -TimeToMillis $TimeToMillis -Devices $Devices -Countries $Countries -Companies $Companies -Statuses $Statuses -Categories $Categories -Search $Search -Limit $Limit -Cursor $Cursor
} catch {
    Write-Host ("Exception occurred when calling Get-QueryLog: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TimeFromMillis Int64 Time from in milliseconds (inclusive)
TimeToMillis Int64 Time to in milliseconds (inclusive)
Devices String[] Filter by devices [optional]
Countries String[] Filter by countries [optional]
Companies String[] Filter by companies [optional]
Statuses FilteringActionStatus[] Filter by statuses [optional]
Categories CategoryType[] Filter by categories [optional]
Search String Filter by domain name [optional]
Limit Int32 Limit the number of records to be returned [optional] [default to 20]
Cursor String Pagination cursor. Use cursor from response to paginate through the pages. [optional]

Return type

QueryLogResponse (PSCustomObject)

Authorization

ApiKey, AuthToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]