API: HTTP Delete Segmentation Rule
The Delete Segmentation Rule command allows you to remove any existing Segmentation Rule from your realm. .
Arguments
The Delete Segmentation Rule command requires the following arguments: Command, Realm, Password, and Segmentation ID or Name.
api_web?r=myrealm&p=mypass&c=deleteseg&segmentation_id=2
The command is ‘deleteseg', the realm is ‘myrealm’ and the password is ‘mypass’. The rule with id '2' will be deleted.
The Delete Segmentation Rule command supports the following arguments:
Name | Req? | Description | Argument |
Command | Yes | Defines the command to use. | cmd=deleteseg c=deleteseg |
Realm | Yes | Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match. | realm=[realm_name] r=[realm_name] |
Password | Yes | Authentication code for API access. This is required, and the command will fail if the realm and password do not match. | pwd=[password] p=[password] |
Segmentation Rule | Yes | Identifier of the Segmentation Rule to delete. Use either the rule Name or ID. | segmentation_id=[segmentation_id] segmentation_name=[segmentation_name] |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only).
api_web?r=myrealm&p=mypass&c=deleteseg&segmentation_id=2
Successful results for one call return, where ‘2’ is the rule ID:
SUCCESS: 2
Results
The Delete Segmentation Rule command outputs either a SUCCESS or FAILURE message.
SUCCESS
The Delete Segmentation Rule command success message returns the SUCCESS message and the rule ID. The result format is:
SUCCESS: [segmentation_rule_id]
FAILURE
A Delete Segmentation Rule command will fail for several reasons, such as if the rule does not exist. The result format is:
FAILURE: [Reason]