## /status/app/proxy/forwardProxy/<name>/virtualIP/<vip_name>

Use

Use to view the name of the virtual IP for the forward proxy.

### Parameters

name: Name of forward proxy object

vip_name: Name of virtual IP object--Must use only a [limited character set](/
Release_1.6/250REST_API_Reference_Guide/000Getting_Started_with_the_REST_API/3
00Understanding_the_REST_Hierarchy#Limited_Character_Set).

### Data Key

The data key contains the virtual IP name.

Note: When the default key is set to true, it means the object is set to its
default. In this case, the system works as follows:

  * On a PUT operation, the system ignores the data key. (Applicable only to /config nodes.)
  * On a GET operation, the response only contains "default": True and does not contain the data key.
  * If the object has a base, it inherits its setting from its base.

See [Setting Objects to Their Default](https://docs.lineratesystems.com/087Rel
ease_2.6/250REST_API_Reference_Guide/000Getting_Started_with_the_REST_API/300U
nderstanding_the_REST_Hierarchy#Setting_Objects_to_Their_Default_(Default_Key)
).

#### Data Type

string

#### Default Data Value

""

An object uses the default data value when one of the following is true:

  * For objects without bases--When the object's default key is true.
  * For objects with bases--When the object's default key is true, and when the default key is true for all of the object's bases.

### Default Allowed

False

### Request Methods

GET

### Related

REST API Reference - [/config/app/proxy/forwardProxy](https://docs.lineratesys
tems.com/087Release_2.6/250REST_API_Reference_Guide/config/app/proxy/forwardPr
oxy)

CLI Reference - [Show Forward Proxy Commands](/087Release_2.6/200CLI_Reference
_Guide/Exec_Commands/Show_Commands/Show_Forward_Proxy_Commands)

### Examples

GET

curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forw
ardProxy/fp-01/virtualIP/vip-01

GET Response

    
    
    {"/status/app/proxy/forwardProxy/fp-01/virtualIP/vip-01": {"data": "vip-01",
                                                                "default": False,
                                                                "defaultAllowed": False,
                                                                "deleteAllowed": True,
                                                                "numChildren": 0,
                                                                "type": "string"},
     "httpResponseCode": 200,
     "recurse": False,
     "requestPath": "/status/app/proxy/forwardProxy/fp-01/virtualIP/vip-01"}
    

GET (list children)

curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forw
ardProxy/fp-01/virtualIP/vip-01?op=list

GET Response

    
    
    {"/status/app/proxy/forwardProxy/fp-01/virtualIP/vip-01": {"default": False,
                                                                "defaultAllowed": False,
                                                                "deleteAllowed": True,
                                                                "numChildren": 0,
                                                                "type": "subtree"},
     "httpResponseCode": 200,
     "recurse": False,
     "requestPath": "/status/app/proxy/forwardProxy/fp-01/virtualIP/vip-01"}
    

GET (recursively list children)

curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/status/app/proxy/forw
ardProxy/fp-01/virtualIP/vip-01?level=recurse

  1. /status/app/proxy/forwardProxy/<name>/virtualIP/<vip_name>
    1. Parameters
    2. Data Key
      1. Data Type
      2. Default Data Value
    3. Default Allowed
    4. Request Methods
    5. Related
    6. Examples