add url action docs
This commit is contained in:
26
docs/docs/functions/url_actions.md
Normal file
26
docs/docs/functions/url_actions.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# URL Actions
|
||||
|
||||
URL Actions will run against an agent and open a configured URL in a new browser tab or window. This allows for integrations with various remote viewing softwares.
|
||||
|
||||
## Adding URL Actions
|
||||
|
||||
In the dashboard, browse to **Settings > Global Settings > URL Actions**. The available options are:
|
||||
|
||||
- **Name** - This identifies the URL Action in other parts of the dashboard
|
||||
- **Description** - Optional description for the URL Action
|
||||
- **Pattern** - This is the actual URL pattern that will open in the new browser tab/window. This field supports variables from the [Global Keystore](keystore.md) and [Script Variables](../script_variables.md).
|
||||
|
||||
### URL Pattern Example
|
||||
|
||||
!!!info
|
||||
Variable names are *case sensitive*!
|
||||
|
||||
```
|
||||
https://remote.example.com/connect?API_KEY={{global.API_KEY}}&agent_id={{agent.Remote ID}}
|
||||
```
|
||||
|
||||
The above example uses a value defined in the **global keystore** named *API_KEY* and an **Agent custom field** called *remote id*. The URLs are properly encoded to work with any special characters or spaces returned in the values.
|
||||
|
||||
## Running URL Actions
|
||||
|
||||
In the agent table, right-click on the Agent and select **Run URL Action** and select the action to run
|
||||
@@ -17,6 +17,7 @@ nav:
|
||||
- "Global Keystore": functions/keystore.md
|
||||
- "Custom Fields": functions/custom_fields.md
|
||||
- "Remote Background": functions/remote_bg.md
|
||||
- "URL Actions": functions/url_actions.md
|
||||
- "Maintenance Mode": functions/maintenance_mode.md
|
||||
- "Alerting": alerting.md
|
||||
- "User Interface Preferences": functions/user_ui.md
|
||||
|
||||
Reference in New Issue
Block a user