All URIs are relative to /api/v1
Method | HTTP request | Description |
---|---|---|
Get-GroAdminDashboard | GET /system/dashboard | getDashboard |
Get-GroAdminServiceInfo | GET /system/dashboard/services/{unit} | getServiceInfo |
Get-GroAdminServicesList | GET /system/dashboard/services | getServicesList |
Send-GroAdminServiceSignal | POST /system/dashboard/services/{unit}/{action} | sendServiceSignal |
SystemDashboardResponse Get-GroAdminDashboard
getDashboard
Get System dashboard data
# getDashboard
try {
$Result = Get-GroAdminDashboard
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminDashboard: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
This endpoint does not need any parameter.
SystemDashboardResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Service Get-GroAdminServiceInfo
[-Unit]
getServiceInfo
Get information about a specific service
$Unit = "MyUnit" # String | Name of the unit to signal
# getServiceInfo
try {
$Result = Get-GroAdminServiceInfo -Unit $Unit
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminServiceInfo: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
Unit | String | Name of the unit to signal |
Service (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SystemDashboardServicesResponse Get-GroAdminServicesList
getServicesList
Get list of services
# getServicesList
try {
$Result = Get-GroAdminServicesList
} catch {
Write-Host ("Exception occurred when calling Get-GroAdminServicesList: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
This endpoint does not need any parameter.
SystemDashboardServicesResponse (PSCustomObject)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void Send-GroAdminServiceSignal
[-Unit]
[-Action]
[-XCsrfToken]
sendServiceSignal
Send signal to a service
$Unit = "MyUnit" # String | Name of the unit to signal
$Action = Initialize-Action # Action | Signal to send
$XCsrfToken = "MyXCsrfToken" # String | CSRF Token (optional)
# sendServiceSignal
try {
$Result = Send-GroAdminServiceSignal -Unit $Unit -Action $Action -XCsrfToken $XCsrfToken
} catch {
Write-Host ("Exception occurred when calling Send-GroAdminServiceSignal: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Name | Type | Description | Notes |
---|---|---|---|
Unit | String | Name of the unit to signal | |
Action | Action | Signal to send | |
XCsrfToken | String | CSRF Token | [optional] |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]