Product Documentation

Renaming a NetScaler Resource

Jun 14, 2016

To change the name of an existing resource, specify the action as "rename" in the URL query string, and in the request payload, specify the existing name and the new name.

For example, to change the name of a load balancing virtual server from MyFirstLbVServer to MyServer:

  • Request:

    HTTP Method
    POST
    URL
    http://<netscaler-ip-address>/nitro/v1/config/lbvserver?action=rename
    Request Headers
    Cookie:NITRO_AUTH_TOKEN=<tokenvalue> 
    Content-Type:application/vnd.com.citrix.netscaler.lbvserver+json
    Request Payload
    { 
        "lbvserver": 
        { 
            "name":"MyFirstLbVServer", 
            "newname":"MyServer" 
        } 
    }
  • Response:

    HTTP Status Code on Success
    200 OK
    HTTP Status Code on Failure
    4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error.