GroAdminSystemAdminProxiesApi.md

GrommunioAdmin.GrommunioAdmin/Api.GroAdminSystemAdminProxiesApi

All URIs are relative to /api/v1

Method	HTTP request	Description
Get-GroAdminAntispam	GET /system/antispam/{path}	getAntispam
Get-GroAdminVhostStatus	GET /system/vhostStatus/{host}	getVhostStatus
Get-GroAdminVhosts	GET /system/vhostStatus	getVhosts

Get-GroAdminAntispam

void Get-GroAdminAntispam
        [-Path]

getAntispam

Proxies any request including query parameters to the grommunio-antispam backend

Example

$Path = "MyPath" # String | grommunio-antispam endpoint to query

# getAntispam
try {
    $Result = Get-GroAdminAntispam -Path $Path
} catch {
    Write-Host ("Exception occurred when calling Get-GroAdminAntispam: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Path	String	grommunio-antispam endpoint to query

Return type

void (empty response body)

Authorization

No authorization required

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-GroAdminVhostStatus

void Get-GroAdminVhostStatus
        [-Host]

getVhostStatus

Make call nginx vhost status endpoint

Example

$Host = "MyHost" # String | Host to query

# getVhostStatus
try {
    $Result = Get-GroAdminVhostStatus -Host $Host
} catch {
    Write-Host ("Exception occurred when calling Get-GroAdminVhostStatus: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Host	String	Host to query

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Get-GroAdminVhosts

SystemVhostStatusResponse Get-GroAdminVhosts

getVhosts

Get list of vhosts

Example

# getVhosts
try {
    $Result = Get-GroAdminVhosts
} catch {
    Write-Host ("Exception occurred when calling Get-GroAdminVhosts: {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

SystemVhostStatusResponse (PSCustomObject)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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