Use the delete operation to remove a specified secret key from the server.
A request XML packet removing a secret key includes the delete operation node:
<packet version="1.4.2.0">
<secret_key>
<delete>
...
</delete>
</secret_key>
</packet>
The delete node has the following graphical representation:
Remarks
You can remove multiple secret keys in a single packet. Add as many key parameters to the filter as the number of keys to be removed.
<filter>
<key>...</key>
...
<key>...</key>
</filter>
The delete node of the output XML packet is structured as follows:
common.xsd
).
This request packet removes secret key 6575fae36288be6d1bad40b99808e37f.
<packet version="1.4.2.0">
<secret_key>
<delete>
<filter>
<key>6575fae36288be6d1bad40b99808e37f</key>
</filter>
</delete>
</secret_key>
</packet>
Response:
<packet version="1.4.2.0">
<secret_key>
<delete>
<result>
<status>ok</status>
<key>6575fae36288be6d1bad40b99808e37f</key>
</result>
</delete>
</secret_key>
</packet>
If the key was not found on the server, the response looks as follows:
<packet version="1.4.2.0">
<secret_key>
<delete>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>Secret key does not exist</errtext>
<key>6575fae36288be6d1bad40b99808e37f</key>
</result>
</delete>
</secret_key>
</packet>
This request packet removes secret keys 6575def8 and 6576d1ef7.
<packet version="1.4.2.0">
<secret_key>
<remove>
<filter>
<key>6575def8</key>
<key>6576d1ef7</key>
</filter>
</remove>
</secret_key>
</packet>
Reponse:
<packet version="1.4.2.0">
<secret_key>
<delete>
<result>
<status>ok</status>
<key>6575def8</key>
</result>
<result>
<status>ok</status>
<key>6576d1ef7</key>
</result>
</delete>
</secret_key>
</packet>