VQL Documentation - URL Parameters

This documentation describes the URL parameters that can be used to configure the VQL application.

Configuration Parameters

The application can be configured using URL parameters passed via hash (#) or query string (?). Hash parameters take precedence.

Parameter	Description	Example
`p`	Use for special modes or connecting to a port on localhost. A port number (e.g., `3000`). `web`: Activates web channel mode (BroadcastChannel).	`#p=3000`
`s, url`	Use to provide a full URL to a VQL server endpoint.	`#s=https://my-vql-server.com/VQL`
`ep`	Custom endpoint path appended to the base URL. Default: `/VQL`	`#ep=/api/vql`
`h`	Base64-encoded JSON object for custom HTTP headers. The value must be a base64-encoded JSON string.	`#h=eyJhdXRob3JpemF0aW9uIjogIkJlYXJlciB0b2tlbiJ9`
`b`	Base64-encoded JSON object for the request body. The value must be a base64-encoded JSON string.	`#h=eyJ0b2tlbiI6ICJhYmMxMjMifQ==`
`ml`	Comma-separated list of adapter logic IDs. When provided, the application uses these adapters instead of fetching them from the server. Useful for testing with mock or custom adapter configurations.	`#ml=buildings,roads,utilities`

Web Channel Mode (`p=web`)

Web channel mode enables communication between the VQL client and a VQL server running in a different browser tab. This is primarily used for development to connect the UI to a local test server without cross-origin (CORS) issues.

To use this mode, you must have the server environment running on the server.html page in a separate tab.

Usage Examples

Connect to local server on port 3000

$host/#p=3000

Connect to a remote server

$host/#s=https://my-vql-server.com

Use Web Channel Mode

$host/server.html

$host/#p=web

Custom endpoint path

$host/#s=http://localhost:8080&ep=/api/vql

Custom headers (base64-encoded JSON)

$host/#h=eyJhdXRob3JpemF0aW9uIjogIkJlYXJlciB0b2tlbiJ9

Custom body (base64-encoded JSON)

$host/#b=eyJ0b2tlbiI6ICJhYmMxMjMifQ==

Mock adapters list

$host/#ml=buildings,roads,utilities

Combined example

$host/#s=http://localhost:8080&ep=/VQL&h=eyJhdXRob3JpemF0aW9uIjogIkJlYXJlciB0b2tlbiJ9&ml=buildings,roads