Page tree

The delete API uses the DELETE method to remove a policy. You must provide authentication credentials by using the login API before accessing the data. For information about the authentication process, see Web services authentication.

URL to access the delete API

The generic format of a URL for the delete API is as follows:
http://<TSPShostname:port#>/tsws/10.0/api/unifiedadmin/Policy/<id>/delete?idType=id

Example

http://tspspanna:80/tsws/10.0/api/unifiedadmin/Policy/policy203/delete?&idType=name

Entry

Description

http|https

Type of protocol to send the request. Infrastructure Management support both HTTP and HTTPS protocols.

serverHost

Host name of the BMC TrueSight Infrastructure Management Server that has Central Monitoring Administration

port

Port number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

policyIdentifier

Identifier to search the policy. The supported identifiers are as follows:

  • name of the policy
  • identifier for the policy

identifierType

Type of the identifier that you have provided in the request. You can provide multiple identifiers, separated by commas. The supported values are as follows, and the default value is name.

  • name
  • id

Response information for the delete API

A sample JSON response is as follows:

{
    "response": [
        {
            "name": "policy203", 
            "statusCode": "200", 
            "statusMsg": "Successfully deleted policy", 
            "resultHandle": "724"
        }, 
        {
            "name": "policy203_blackout", 
            "statusCode": "200", 
            "statusMsg": "Successfully deleted policy", 
            "resultHandle": "725"
        }
    ], 
    "statusCode": "200", 
    "statusMsg": "OK", 
    "responseTimeStamp": "2012-06-20T10:36:50", 
}

Related topics

Creating a policy using web services

Managing policies using web services

Performing Central Monitoring Administration functions with web services