Virtual Proxy: Create

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

Method

POST

Path

/qrs/virtualproxyconfig/

Description

Create and configure a virtual proxy. The following example shows only a basic configuration. The prefix and sessionCookieHeaderName must be unique for each virtual proxy. Properties that are not configured will be set to system defaults.

Note: A virtual proxy must be linked to a proxy service before the virtual proxy is available for use. See: Virtual Proxy: Link.

Body

{ "prefix": "hdr", "description": "Test proxy", "sessionCookieHeaderName": "X-Qlik-Session-hdr" }

Return value

{ "id": "d4b844ba-66cc-4a38-aa6c-8d0516641bc2", "createdDate": "2017-02-22T18:09:51.896Z", "modifiedDate": "2017-02-22T18:09:51.896Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "prefix": "hdr", "description": "Test proxy", "authenticationModuleRedirectUri": "", "sessionModuleBaseUri": "", "loadBalancingModuleBaseUri": "", "loadBalancingServerNodes": [], "authenticationMethod": 0, "headerAuthenticationMode": 0, "headerAuthenticationHeaderName": "", "headerAuthenticationStaticUserDirectory": "", "headerAuthenticationDynamicUserDirectory": "", "anonymousAccessMode": 0, "windowsAuthenticationEnabledDevicePattern": "Windows", "sessionCookieHeaderName": "X-Qlik-Session-hdr", "sessionCookieDomain": "", "additionalResponseHeaders": "", "sessionInactivityTimeout": 30, "extendedSecurityEnvironment": false, "websocketCrossOriginWhiteList": [], "defaultVirtualProxy": false, "tags": [], "samlMetadataIdP": "", "samlHostUri": "", "samlEntityId": "", "samlAttributeUserId": "", "samlAttributeUserDirectory": "", "samlAttributeSigningAlgorithm": 0, "samlAttributeMap": [], "jwtAttributeUserId": "", "jwtAttributeUserDirectory": "", "jwtPublicKeyCertificate": "", "jwtAttributeMap": [], "magicLinkHostUri": "", "magicLinkFriendlyName": "", "privileges": null, "impactSecurityAccess": false, "schemaPath": "VirtualProxyConfig" }

Optional parameters

-

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?