Set a probe property

This request changes the values of probe properties. It can also create new properties. All new properties created in this way require a string value.

Important: Although this request can change or set the values of all probe properties, the change might not change the behavior of the probe. Most probe properties are read only when the probe starts, and are not subsequently reread, Functionality delivered in fix pack 22unless the Props.LiveUpdate property in the properties file is set to TRUE.

You might need to restart the probe so that the change to the property value changes the behavior of the probe. If you are working with a failover pair, ensure that changes you make to the master probe are also propagated to the slave.

Functionality delivered in fix pack 22If Props.LiveUpdate is set to TRUE then any updates to the properties file become effective immediately with the exception that property values that have been set using the REST API, always override those in the properties file.

The following table describes the features of this request.

Feature Description
URI probe/common
Method PATCH
Accepted MIME types application/json
Query parameters None

Samples

The following example shows a sample request, which causes the RawCapture property to be set to 1.
{
	"properties":	{
		"RawCapture":	1
	}
}
The following example shows an invalid request, because the RawCapture property requires an integer, not a string. The request will cause a 400 Bad Request response.
{
	"properties":	{
		"RawCapture":	"yes"
	}
}
The following example shows a sample request that creates two new properties: MyProperty, which has the value busy, and AnotherProp, which has the value no.
{
	"properties":	{
		"MyProperty":	"busy",
		"AnotherProp":	"no"
	}
}

HTTP response codes

The following table shows the possible response codes that might be returned by this request. This table is not exhaustive.
Response code Explanation
200 OK The request was successful and the property values were changed.
400 Bad Request This response code might be for one of the following reasons:
  • Invalid JSON data was sent.
  • An invalid data type was provided for an existing property.
  • An attempt was made to overwrite the value of an encrypted property.
  • An attempt was made to create new property that is not a string.
500 Internal Server Error An internal error prevented the action from completing.

To troubleshoot the request, perform a GET request to check whether any of the required properties were changed. If they were not, resubmit the request.