Loading...

REST API - DELETE Virtual Server Agent Client

This operation removes a Virtual Server Agent client from the CommCell environment. The client must have had the VSA license removed prior to running the delete operation.

Request

Syntax

Send the request using the client name of the VSA client.

DELETE <webservice>/v2/vsa/hypervisors?clientName={clientName} HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

clientName

The client name of the VSA client to remove.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid value is application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Examples

Sample Request

DELETE <webservice>/v2/vsa/hypervisors?clientName=Amazon_Nov17 HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>

Sample Response

{
  "processinginstructioninfo":{
    "attributes": [{
      "name": "exitval",
      "value": "0"
    }]
  },
  "response": [{
    "errorCode": 0,
    "entity": {
      "clientName": "Amazon_Nov17",
      "clientId": 1987,
      "_type_": 3
    }
  }]
}

Last modified: 3/11/2020 4:39:12 PM