Skip to main content Skip to complementary content

Virtual Proxy: Link

Information noteLOCKED.

This API is extremely reliable and will not be broken unless absolutely necessary.






Link a virtual proxy to a proxy service. A virtual proxy must be linked to a proxy service before the virtual proxy is available for use.

To prevent conflicts when updating entities:

  1. Retrieve the entity that you want to update.

  2. Modify the specific properties that you want to change.
  3. Perform an update, including the entire entity in the body of the request.

You must always include the entity ID and modifiedDate when performing an update. The entity ID of the body and of the URL must match.

To link a virtual proxy to a proxy service:

  1. Get the ID of the virtual proxy that you want to link to a proxy service: GET qrs/virtualproxyconfig

    The ID can be found after "authenticationMethod" by searching for "id":

    Code output showing where to find the proxy ID.

  2. Get the full configuration details of the proxy service: GET qrs/proxyservice/{id}
  3. Copy the configuration details of the proxy service and paste it into the body of the PUT qrs/proxyservice/{id} request.
  4. Add the virtual proxy ID to the proxy service details on a new line below "virtualProxies": [.

    For example: {"id": "22ab5305-447e-4110-9881-830f0f4fed61"},

    Code output showing where to add virtual proxy ID.

  5. Link the virtual proxy to the proxy service: PUT qrs/proxyservice/{id}

Return value

Code output showing a successfully linked Proxy service and virtual proxy service. Proxy service is the first "id" value. Virtual proxy is the third "id" under settings.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!