<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Object Manipulation

Examples

Rename an object:

/api/rename.htm?id=objectid&value=newname

Set priority of an object (valid values for x are 1 to 5):

/api/setpriority.htm?id=objectid&prio=x

Change properties of objects:

/api/setobjectproperty.htm?id=id_of_object&name=property_name&value=new_value

This function can change most string and number properties of objects (names, numerical values, object identifiers (OID), etc.). Use it with caution. You can discern the property_name parameter by opening the Settings page of an object and looking at the HTML source of the INPUT fields. For example, the INPUT field for the tags of an object has the name tags_. Leave away the underscore _ and use tags as a value for the property_name parameter.

Example

Replace the parameter inheritType with the name of the inheritance type:

/api/setobjectproperty.htm?id=id_of_object&name=inheritType_&value=0_or_1

This internal name must be followed by an underscore (_), in contrast to changing properties above. Use the value 0 for switching off inheritance, and 1 for switching on inheritance. For example, the inheritance type for the scanning interval setting has the name intervalgroup_. Thus, this specific part in the URL is &name=intervalgroup_&value=0 (switches off inheritance for scanning interval).

This call does not work with the Schedule, Dependencies, and Maintenance Window settings.

Example: Enabling and Setting Limits for Channels

Set limits for channels:

/api/setobjectproperty.htm?id=sensorid&subtype=channel&subid=0&name=limitmaxerror&value=limitvalue

You have to set the limits for a channel before you can enable limits.

Enable limits for channels:

/api/setobjectproperty.htm?id=sensorid&subtype=channel&subid=0&name=limitmode&value=1

For example, the following API call sets the upper error limit of a channel with the ID 0 of a sensor with the ID 2970 to the value 25.

/api/setobjectproperty.htm?id=2970&subtype=channel&subid=0&name=limitmaxerror&value=25

For Toplists, you can use the subtype toplist to change the properties. When using this subtype, subid is the ID of a Toplist.

Examples

Pause a sensor or object indefinitely:

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

Pause a sensor or object for x minutes:

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

The pause message is optional. You can leave out the parameter &pausemsg=yourmessage if you do not want to display a message.

Simulate an error for a sensor:

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

simulate.htm only works for sensors in an Up, Warning, Unusual, or Unknown status.

Resume monitoring of a sensor or object:

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

Example

Acknowledge a Down status:

/api/acknowledgealarm.htm?id=objectid&ackmsg=yourmessage

Examples

Scan a sensor now:

/api/scannow.htm?id=objectid

Run an auto-discovery for a group or device:

/api/discovernow.htm?id=objectid&template=filename

Providing a device template for auto-discovery is optional. You can leave out the parameter &template=filename to run the auto-discovery with the options defined in the object's settings. If you use a template, provide the whole file name including file extension surrounded by double quotes and encode whitespaces, if necessary. Example: &template="Linux%20SNMP.odt"

discovernow.htm overrides the Auto-Discovery setting of the target group or device. If it is set to No auto-discovery, it automatically changes to Standard auto-discovery (recommended).

Example

Move an object in the sensor tree (x can be up, down, top, bottom):

/api/setposition.htm?id=objectid&newpos=x

Example

Add a group, device, or sensor to a report:

/api/reportaddsensor.htm?id=reportid&addid=objectid

Example

Trigger a notification immediately for testing purposes:

/api/notificationtest.htm?id=objectid

/api/notificationtest.json?id=objectid

objectid is the ID of the notification template.

Example

Delete an object:

/api/deleteobject.htm?id=objectid&approve=1

Examples

Duplicate a group:

/api/duplicateobject.htm?id=id_of_group_to_clone&name=new_name&targetid=id_of_target_group

Duplicate a device:

/api/duplicateobject.htm?id=id_of_device_to_clone&name=new_name&host=new_hostname_or_ip&targetid=id_of_target_group

Duplicate a sensor:

/api/duplicateobject.htm?id=id_of_sensor_to_clone&name=new_name&targetid=id_of_target_device

Duplicate a library:

/api/duplicateobject.htm?id=id_of_library_to_clone&name=new_name

Duplicate a notification template:

/api/duplicateobject.htm?id=id_of_notification_template_to_clone&name=new_name

If duplicateobject succeeds, the PRTG core server replies with a redirect to the URL of the new object (for example, /sensor.htm?id=1234), so your application should parse the new object ID from this URL.

When a group, device, or sensor is cloned, it is initially set to Paused so you have the chance to edit parameters as desired. You must resume it with an API call afterward.

The API calls for duplicating reports, maps, libraries, and notification templates do not require a targetid.

Example

Duplicate the sensor (the server replies with a redirect to the new object's web page, for example /sensor.htm?id=10214, parse id 10214 from the URL):

/api/duplicateobject.htm?id=2002&name=mynewsensor&targetid=2001

Rename the new sensor:

/api/setobjectproperty.htm?id=10214&name=name&value=newname

Change the OID (in this example for an SNMP Custom sensor):

/api/setobjectproperty.htm?id=10214&name=oid&value=1.2.3.4.5.6.7

Resume monitoring for the new sensor:

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

Example

Set the geo location of an object:

/api/setlonlat.htm?id=objectid&location=name_of_object_location&lonlat=longitude,latitude