Add a new Watchpoint (POST)


The POSTcommand adds a new Watchpoint by providing the Watchpoint XML representation and content. To perform this procedure, you must have Operator-level access, or higher.

Note

The content type must be set to text/xml when you use the POST method.

Command overview

Method — POST
 Resource — Watchpoint

Parameters

Parameter

Description

Example

usr 1

A valid system user name (case sensitive)

usr=myUsername

pwd 1

The password that corresponds to the usr (user name) parameter (case sensitive)

pwd=myPassword
tid

The transaction identifier (tid). You must specify the tid for all stateful operations. Do not include it in stateless operations.

tid=5456

 1 This parameter is required.

Sample request

https://10.0.0.1/rest/configurationapi/watchpointapi/1.0/watchpoint?usr=jdoe&pwd=pa55w0rd!&tid=4738
...
<watchpoint type="object" active="false" active-mib="true" filter-selection="all">
<name><![CDATA[Potential Problem - Excessive TCP Retransmissions]]></ name>
<description><![CDATA[Matches pages with high retransmission counts]]></ description>
<filter active="true">
 <description><![CDATA[Excessive retransmissions]]></description>
 <name><![CDATA[Excessive retransmissions]]></name>
 <expression><![CDATA[(tcp_rtx > 10)]]></expression>
</filter>
<performance metric="ssl" tolerated="5" frustrated="14"/>
<performance metric="tcp" tolerated="6" frustrated="15"/>
</watchpoint>

Sample response

The XML returned in the response contains the Watchpoint ID of the new Watchpoint.

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <status result="success"></status>
 <result>
  <watchpoint id="28"/>
 </result>
</response>

Related topic

Watchpoint-API-XML-reference

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*