Use API to assign Schedules to sensors

Dear jankar

The short answer is: That is not possible.

The long answer is: It is possible in principle, however we don't provide technical support for this. Only some parts of PRTG management can be accessed through the API. Of that, only a part is documented.

If you manually change the schedule for an object and analyse the HTTP POST generated by the webinterface, you could try to create your own API call derived from that POST.

Another option would be to stop the PRTG core service and change the "PRTG Configuration.dat" (which is an XML file) directly. However, this method is not recommended as it is very easy to unintentionally damage the configuration.

There is a way to pause objects via the API. That would be the alternative: Write a script which pauses / resumes objects instead of changing the schedule attached.

To pause an object for x minutes:

/api/pauseobjectfor.htm?id=objectid&pausemsg=yourmessage&duration=x 

To pause it until it is resumed:

/api/pause.htm?id=objectid&pausemsg=yourmessage&action=0 

To resume it:

/api/pause.htm?id=objectid&action=1

any news regarding this feature?

I would like to automate the notification schedule on both groups and single sensors via the API, is that still not possible?

Hello Olav,

Nothing new so far. Arne posted some workaround for some automatition, though if your aim is to indeed tinker with the schedules only for notification, this won't be ideal. It also collides with how notifications are organized, since schedules can be set directly in a notification, telling it when to be active and when not, indepedently of whether the sensor is running or not. Now since notifications are sort of organized centrally, you cannot have the same notification behave differently for one sensor than on another sensor where the same notification is in place. This would only be feasible by having differently configured notifications, each one with configured schedules if necessary.

Kind regards,

Erhard

You can do this with the PRTGAPI powershell module. Here's a Cmdlet to use. *WARNING* This modifies raw properties and may have unexpected side effects. Works pretty stable for us but use at your own risk.

#requires -module prtgapi
<#
.EXAMPLE
$schedule = Get-PRTGSchedule "Sundays*" | select -first 1
Get-Device mytestdevice | Set-PRTGSchedule -Schedule $schedule
#>
function Set-PRTGSchedule {
    [CmdletBinding(SupportsShouldProcess)]
    param (
        [Parameter(Mandatory,ValueFromPipeline)][prtgapi.deviceorgrouporprobe]$Object,
        [Parameter(Mandatory)][prtgapi.schedule]$Schedule
    )

    begin {
        if (-not (Get-PrtgClient)) {Connect-PrtgServer}
    }

    process {
        if (-not $Object.id) {
            write-error "Could not find valid ID on schedule object $schedule"
            continue
        }

        [string]$scheduleValue = ($Schedule.id,$schedule.name -join '|') + '|'
        if ($PSCmdlet.ShouldProcess($Object.name,"Set Schedule to $($Schedule.name)")) {
            Set-ObjectProperty -Force -Object $Object -RawParameters @{
                scheduledependency = 0
                schedule_ = $scheduleValue
            }
        }
    }
}