Use the delete operation to remove a specified secret key from the server.
Request Packet Structure
A request XML packet removing a secret key includes the delete operation node:
The delete node has the following graphical representation:
- The filter node is required. It specifies the filtering rule. To remove all secret keys located on the server, use the blank filter node (<filter/>). Data type: complex.
- The key node is optional. To remove a specified key, set the key value for this node. Data type: string.
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.
Response Packet Structure
The delete node of the output XML packet is structured as follows:
- The result node is required. It wraps the response retrieved from the server. Data type: resultType (
- The status node is required. It specifies the execution status of the delete operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. Is returns the error code if the delete operation fails. Data type: integer.
- The errtext node is optional. It returns the error message if the delete operation fails. Data type: string.
- The key node is optional. It holds the key value if the operation succeeds. Data type: string.
Removing a secret key
This request packet removes secret key 6575fae36288be6d1bad40b99808e37f.
If the key was not found on the server, the response looks as follows:
Removing multiple secret keys
This request packet removes secret keys 6575def8 and 6576d1ef7.