Guardsix

https://docs.guardsix.com/
Admin
Guardsix is a comprehensive security platform offering sovereign log management, network detection,...
Tokens:1,017,407
Snippets:11,718
Trust Score:7.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Application Request Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/upload.md

Provides an example JSON payload for installing an application. Ensure 'application_type', 'file_location', and 'file_name' are correctly specified.

```json
{
    "data": {
        "application_type": "Application",
        "file_location": "private",
        "file_name": "test_1.0.0.pak"
    }
}
```

--------------------------------

### Linux Default Installation with Osquery

Source: https://docs.guardsix.com/agentx/references

Example command for a default AgentX Client installation on Linux, including osquery. Uses the install script with manager address and osquery installation flag.

```bash
./install.sh MANAGER_ADDRESS=192.168.1.100 OSQUERY_INSTALL=Y
```

--------------------------------

### Query Documentation Example

Source: https://docs.guardsix.com/siem/siem-apis/token-based-api/snmp-settings-api.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.guardsix.com/siem/siem-apis/token-based-api/snmp-settings-api.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install BoxAudit - Install API Request Example

Source: https://docs.guardsix.com/integrations/box-audit/ingest-box-logs-via-director-apis.md

This is an example request body for installing BoxAudit. Ensure the application_type is 'Application', and provide the correct file_name and file_location.

```json
{
 "data": {
     "application_type": "Application",
     "file_name": "BoxAudit.pak",
     "file_location": "private"
 }
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-standalone/monitoring-and-troubleshooting.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' parameters.

```http
GET https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-standalone/monitoring-and-troubleshooting.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example Querying Documentation

Source: https://docs.guardsix.com/siem/siem-apis/token-based-api/backup-and-restore-api.md

Demonstrates how to query the documentation dynamically using HTTP GET with 'ask' and 'goal' parameters.

```http
GET https://docs.guardsix.com/siem/siem-apis/token-based-api/backup-and-restore-api.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation API Example

Source: https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-centralized/configure-logpoint-agent-centralized.md

Example of how to query the GitBook documentation dynamically using an HTTP GET request with 'ask' and 'goal' parameters.

```http
GET https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-centralized/configure-logpoint-agent-centralized.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Windows Default Installation with Osquery

Source: https://docs.guardsix.com/agentx/references

Example command for a default AgentX Client installation on Windows, including osquery. Uses msiexec with specified manager address and osquery feature.

```bash
msiexec /i AgentX_Client_windows_1.8.0.msi MANAGER_ADDRESS=192.168.1.100 ADDLOCAL=OsqueryFeature /qn
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.guardsix.com/siem/understand/core-concepts/alert-rules-notifications-and-templates.md

Provides an example of how to query the documentation dynamically using an HTTP GET request with `ask` and optional `goal` parameters.

```http
GET https://docs.guardsix.com/siem/understand/core-concepts/alert-rules-notifications-and-templates.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.guardsix.com/integrations/palo-alto-network-firewall/palo-alto-log-reference.md

Example of how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters. This is useful for retrieving information not explicitly present on the page.

```http
GET https://docs.guardsix.com/integrations/palo-alto-network-firewall/palo-alto-log-reference.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Example

Source: https://docs.guardsix.com/integrations/unix/unixlogs.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters.

```http
GET https://docs.guardsix.com/integrations/unix/unixlogs.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Windows Custom Path Installation with Osquery Config

Source: https://docs.guardsix.com/agentx/references

Example command for a custom AgentX Client installation on Windows. Specifies custom paths for installation directory and osquery configuration, along with the manager address.

```bash
msiexec /i AgentX_Client_windows_1.8.0.msi MANAGER_ADDRESS=192.168.1.100 INSTALLATION_TYPE=custom INSTALL_DIR="D:\\AgentX" ADDLOCAL=OsqueryFeature CUSTOM_OSQUERY_CONF="D:\\Config\\osquery.conf" /qn
```

--------------------------------

### FortiGate Log Query Example

Source: https://docs.guardsix.com/integrations/fortigate/fortigate-log-reference.md

Demonstrates how to query FortiGate documentation dynamically using an HTTP GET request with 'ask' and 'goal' parameters.

```http
GET https://docs.guardsix.com/integrations/fortigate/fortigate-log-reference.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation API Example

Source: https://docs.guardsix.com/director/plan-and-deploy-director/deploy-director/install-director-components.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' parameters.

```http
GET https://docs.guardsix.com/director/plan-and-deploy-director/deploy-director/install-director-components.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Windows Custom Path Installation with Osquery Config

Source: https://docs.guardsix.com/agentx/references/installation-flags-reference.md

Example command for a custom AgentX Client installation on Windows, specifying a custom path and osquery configuration file.

```cmd
msiexec /i AgentX_Client_windows_1.8.0.msi MANAGER_ADDRESS=192.168.1.100 INSTALLATION_TYPE=custom INSTALL_DIR="D:\AgentX" ADDLOCAL=OsqueryFeature CUSTOM_OSQUERY_CONF="D:\Config\osquery.conf" /qn
```

--------------------------------

### Windows Custom SSL Certificates Installation

Source: https://docs.guardsix.com/agentx/references

Example command for installing AgentX Client on Windows with custom SSL certificates. Specifies paths for both the SSL certificate and its key file.

```bash
msiexec /i AgentX_Client_windows_1.8.0.msi MANAGER_ADDRESS=192.168.1.100 ADDLOCAL=OsqueryFeature SSL_CERT="D:\\Certs\\agent.cert" SSL_KEY="D:\\Certs\\agent.key" /qn
```

--------------------------------

### Linux Custom SSL Certificates Installation

Source: https://docs.guardsix.com/agentx/references

Example command for installing AgentX Client on Linux with custom SSL certificates. Specifies manager address, osquery installation, and paths for the SSL certificate and key file.

```bash
./install.sh MANAGER_ADDRESS=192.168.1.100 OSQUERY_INSTALL=Y SSL_CERT=/opt/certs/agent.cert SSL_KEY=/opt/certs/agent.key
```

--------------------------------

### Query Documentation with `ask` Parameter

Source: https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-standalone/configure.md

Example of how to query the documentation dynamically using an HTTP GET request with the `ask` query parameter.

```http
GET /?ask=What+is+the+UDP+reconnect+mechanism HTTP/1.1
Host: localhost:8080
```

--------------------------------

### Get OpenDoor Success Response Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/opendoor.md

Example of a successful response when retrieving a single OpenDoor configuration.

```json
{
    "id": "574fb123d8aaa4625bfe2d23",
    "mtu": 1500,
    "netmask": "255.255.255.0",
    "network": "10.4.0.1",
    "opened": "on",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8"
}
```

--------------------------------

### Start Logpoint Agent Standalone Service

Source: https://docs.guardsix.com/logpoint-agents/logpoint-agents/logpoint-agent-standalone/getting-started.md

Use this command to start the Logpoint agent service after installation and configuration.

```powershell
Start-Service lpagentstandalone
```

--------------------------------

### Query Documentation Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/mitreattacks.md

Demonstrates how to query the documentation dynamically using an HTTP GET request. Include your question in the 'ask' parameter and an optional 'goal' parameter for tailored responses.

```http
GET https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/mitreattacks.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with `ask` Parameter

Source: https://docs.guardsix.com/integrations/box-audit/ingest-box-logs-via-director-apis.md

This example shows how to query the documentation dynamically using an HTTP GET request with the `ask` and optional `goal` query parameters.

```http
GET https://docs.guardsix.com/integrations/box-audit/ingest-box-logs-via-director-apis.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Windows Custom SSL Certificates Installation

Source: https://docs.guardsix.com/agentx/references/installation-flags-reference.md

Example command for installing AgentX Client on Windows with custom SSL certificates.

```cmd
msiexec /i AgentX_Client_windows_1.8.0.msi MANAGER_ADDRESS=192.168.1.100 ADDLOCAL=OsqueryFeature SSL_CERT="D:\Certs\agent.cert" SSL_KEY="D:\Certs\agent.key" /qn
```

--------------------------------

### RefreshList GET API Response Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/refreshlist.md

This JSON represents the response when querying the status of a RefreshList operation using a GET request.

```json
{
    "request": {},
    "logpoint_identifier": "2ea932a7bea4451b855967837d552a34",
    "pool_uuid": "d97ef7c482a849a4b4b8f6ca06a312c3",
    "response": {
        "success": true,
        "message": "Entities to sync updated"
    }
}
```

--------------------------------

### Get ODBC Fetcher Log Source Request

Source: https://docs.guardsix.com/siem/siem-apis/token-based-api/odbc-fetcher-api.md

Example of a GET request to retrieve a specific ODBC Fetcher log source by its ID.

```http
GET https://Logpoint-IP/api/v1/odbc-fetcher/{logsource_id}
```

--------------------------------

### Get Distributed Collector API Response Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/distributedcollectors.md

This is an example of a successful response when fetching details for a distributed collector. It includes various attributes of the collector.

```json
{
    "active": true,
    "buffering": true,
    "description": "",
    "file_socket_port": 6900,
    "id": "59b62b15d8aaa4245809137f",
    "identifier": "a8131f6cfb314e87b7cfdaedfee238a0",
    "ip": "192.168.100.79",
    "is_li_light": true,
    "name": "LogPoint79",
    "tid": ""
}
```

--------------------------------

### Install Certificate and Key

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/systemsettingshttps.md

Use this endpoint to install a certificate and its corresponding key on a logpoint. Ensure the certificate and key files exist at the specified location.

```json
{
    "data": {
        "certificate": "ssl.crt",
        "file_location": "private",
        "key": "ssl.key"
    }
}
```

--------------------------------

### Install AgentX Client with Default Settings

Source: https://docs.guardsix.com/agentx/plan-and-deploy/deploy-endpoints/install-agentx-client-on-windows-individual.md

Use this command to install the AgentX Client with default settings. Replace `XX.XX.XX.XX` with your Logpoint IP address.

```cmd
msiexec /i AgentX_Client_windows_version.msi MANAGER_ADDRESS=XX.XX.XX.XX ADDLOCAL=OsqueryFeature /qn
```

--------------------------------

### Install List

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/lists.md

Installs a given .pak, .txt or .csv file containing lists.

```APIDOC
## POST /configapi/{pool_UUID}/{logpoint_identifier}/Lists/install

### Description
Installs a given .pak, .txt or .csv file containing lists.

### Method
POST

### Endpoint
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Lists/install

### Parameters
#### Request Body
- **file_location** (String) - Required - Location of the file uploaded to install. Can be either 'private' or 'public'.
- **file_name** (String) - Required - Name of the .pak, .csv or .txt file containing Lists.

### Request Example
```json
{
    "data": {
        "file_location": "private",
        "file_name": "lists.pak"
    }
}
```

### Response
#### Success Response (200)
- **status** (String) - Description
- **message** (String) - Description

#### Response Example
```json
{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}
```
```

--------------------------------

### Install AgentX Client to a Custom Path

Source: https://docs.guardsix.com/agentx/plan-and-deploy/deploy-endpoints/install-agentx-client-on-windows-individual.md

Install the AgentX Client to a custom directory by specifying the `INSTALL_DIR` parameter. The path must exist prior to installation.

```cmd
msiexec /i AgentX_Client_windows_version.msi MANAGER_ADDRESS=XX.XX.XX.XX INSTALLATION_TYPE=custom INSTALL_DIR="C:\YourPath" ADDLOCAL=OsqueryFeature /qn
```

--------------------------------

### CiscoAMP Product Update Started Event Sample

Source: https://docs.guardsix.com/integrations/ciscoamp/ciscoamp-log-reference.md

Example JSON log for a CiscoAMP Product Update Started event. This illustrates the structure for update-related notifications.

```json
{"CiscoAMP": {"event_type": "Product Update Started", "timestamp": 1551900382, "group_guids": ["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"], "computer": {"connector_guid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "links": {"trajectory": "https://api.amp.cisco.com/v1/computers/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/trajectory", "computer": "https://api.amp.cisco.com/v1/computers/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "group": "https://api.amp.cisco.com/v1/groups/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}, "external_ip": "XXX.XXX.XXX.XXX", "hostname": "SERVER01.corp.example.com", "network_addresses": [{"ip": "XX.X.XXX.XXX", "mac": "XX:XX:XX:XX:XX:XX"}], "active": true}, "event_type_id": 553648000, "date": "2019-03-06T19:26:22+00:00", "timestamp_nanoseconds": 690000000, "id": 0000000000000000000, "connector_guid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}
```

--------------------------------

### Querying Documentation with GitBook

Source: https://docs.guardsix.com/integrations/checkpoint-20software/checkpoint-20firewall/checkpoint-firewall.md

This example demonstrates how to query the documentation dynamically using an HTTP GET request with the `ask` and optional `goal` query parameters. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.guardsix.com/integrations/checkpoint-20software/checkpoint-20firewall/checkpoint-firewall.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Plugin Application File

Source: https://docs.guardsix.com/director/automate-with-apis/api-use-cases/configure-a-pluggable-plugin-from-the-director-console-api.md

Use this API call to install a plugin application file in the Fabric-enabled Logpoint. This is the first step in the plugin setup process.

```bash
GET
https:://api-server-host-name/monitorapi/v1/208118f9ee8049d3a23c2da7ed7f1a3a/3324b10a5bbb4a51891860b50cf7b6b9/orders/70dc7ed9-4a10-464e-86b6-ca4c8079ad6f
```

--------------------------------

### Install S3Fetcher in Logpoint API Success Response

Source: https://docs.guardsix.com/integrations/aws/s3fetcher/ingest-logs/ingest-logs-via-director-console-api.md

This is a success response example for the S3Fetcher installation API. It indicates the status and provides a message with a reference to the order details.

```json
{
    "status": "Success",
    "message": "monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}
```

--------------------------------

### Install S3Fetcher in Logpoint API Request

Source: https://docs.guardsix.com/integrations/aws/s3fetcher/ingest-logs/ingest-logs-via-director-console-api.md

This is a request example for installing S3Fetcher in a Fabric-enabled Logpoint. Specify the application type, file name, and its location (private or public).

```json
{
 "data": {
     "application_type": "Application",
     "file_name": "S3fetcher_3.0.0.pak",
     "file_location": "private"
 }
}
```

--------------------------------

### Create a Routing Policy

Source: https://docs.guardsix.com/director/automate-with-apis/api-use-cases/create-a-collector-or-fetcher-from-the-director-console-api.md

This example demonstrates creating a routing policy. It first lists existing repositories to get a repository name, then uses that name in the RoutingPolicies - Create API call. Ensure the correct pool UUID and logpoint identifier are used.

```http
Config API:
GET
https://api-server-host-name/configapi/v1/{pool_UUID}/{logpoint_identifier}/Repos
[
{
    "repoha": [],
    "name": "TestRepo",
    "repo_number": 4,
    "id": "5af2b7fa20c208313a16f3ca",
    "repopath":
    [
        {
            "path": "/opt/immune/storage/",
            "retention": 10
        }
    ],
    "tid": "",
    "used_size": "0.00000 MB",
    "active": true
}
]

Config API:

POST
https://api-server-host-name/configapi/v1/{pool_UUID}/{logpoint_identifier}/RoutingPolicies
{
    "data":
    {
    "catch_all": "default", 
    "routing_criteria":
    [
      {
        "repo": "TestRepo", 
        "drop": "store", 
        "type": "KeyPresent", 
        "value": "", 
        "key": "user"
      }
    ],
    "policy_name": "TestRoutingPolicy"
    }
}
```

--------------------------------

### Devices - Install API Request (Config API)

Source: https://docs.guardsix.com/director/automate-with-apis/api-use-cases/add-bulk-devices-using-director-console-api.md

This is a sample POST request to the Devices - Install API via the Config API to initiate the installation of device configurations from a specified CSV file located in public storage.

```http
POST
https:://api-server-host-name/configapi/pool_UUID/logpoint_identifier/Devices/install
{
"data": {
"file_name": "devices.csv",
"file_location": "public"
}
}

```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.guardsix.com/director/automate-with-apis/api-use-cases/configure-a-pluggable-plugin-from-the-director-console-api.md

This example shows how to query the documentation dynamically using an HTTP GET request with 'ask' and optional 'goal' query parameters. This is useful for retrieving information not explicitly present on the page.

```bash
GET https://docs.guardsix.com/director/automate-with-apis/api-use-cases/configure-a-pluggable-plugin-from-the-director-console-api.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Monitoring API Request for Installation Order

Source: https://docs.guardsix.com/director/automate-with-apis/api-use-cases/add-bulk-devices-using-director-console-api.md

This is a sample GET request to the Monitoring API to retrieve the status and details of a device installation order, identified by a unique order ID.

```http
GET
https:://api-server-host-name//monitorapi/7b77d08934744fdbd7c1d0194ba22aa/41b5b7fffa6c4e3cb6bc6d799a5ee6e5/orders/4624be84-66db-4248-aca4-2b125d0474c7"

```

--------------------------------

### MachineInfo Success Response Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/machineinfo.md

Example of a successful JSON response when querying the MachineInfo API. It includes details about the LogPoint's mode, name, version, and installation history.

```JSON
{
    "director_mode": "fabric_only",
    "is_lite": false,
    "is_zfs_supported": true,
    "machine_name": "LogPoint",
    "machine_type": "DLP",
    "pool_name": "standalone_pool",
    "version": "7.0.0",
    "version_history": [
        {
            "description": "logpoint 6.0.0",
            "installed_at": 1501147629,
            "package_type": "iso",
            "version": "6.0.0"
        },
        {
            "description": "logpoint 7.0.0",
            "installed_at": null,
            "package_type": "patch",
            "version": "7.0.0"
        }
    ]
}
```

--------------------------------

### Install Sysmon with Configuration

Source: https://docs.guardsix.com/integrations/microsoft/windows/sysmon-and-alerts.md

Use this command in an elevated command prompt to install Sysmon with a specified configuration file.

```powershell
.\sysmon64.exe -i config_file.xml
```

--------------------------------

### Success Response for Get Search Logs

Source: https://docs.guardsix.com/siem/siem-apis/using-access-key/search-api.md

This is an example of a successful response from the Get Search Logs API. The `final` field indicates if all logs have been retrieved. Continue polling if `final` is false.

```json
{
    "num_aggregated": 12345,
    "columns": [
        "count()"
    ],
    "query_type": "chart",
    "rows": [
        {
            "device_ip": "::1"
            ...
        },
        {
            "device_ip": "127.0.0.1"
            ...
        }
    ],
    "grouping": [
        "device_ip"
    ],
    "version": 2,
    "interesting_fields": [],
    "time_range": [
        1582024214,
        1582110614
    ],
    "orig_search_id": "23b4a5fd-d419-4831-bcf5-e6846857fb64",
    "success": true,
    "final": true,
    "totalPages": 1,
    "complete": true,
    "showAdditionalPanels": true,
    "status": {
        ...
    }
}
```

--------------------------------

### Create Plugin Configuration Request Example

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/pluginconfiguration.md

This JSON object demonstrates the structure for creating a new plugin configuration. It includes parameters like frequency, query, and repository.

```json
{
    "data": {
        "frequency": 5,
        "query": "device_name=localhost",
        "repo": "_logpoint"
    }
}
```

--------------------------------

### Setup HTTP Notification Request Example

Source: https://docs.guardsix.com/siem/siem-apis/token-based-api/notification-apis-email-http.md

This JSON object demonstrates the structure for setting up an HTTP notification. It includes fields for the URL, request type, query string, headers, and dispatch options.

```json
{
  "type": "http",
  "http_url": "https://example.com/",
  "http_request_type": "string",
  "http_querystring": "string",
  "notify_http": true,
  "http_format_query": "",
  "http_body": "string",
  "protocol": "HTTPS",
  "dispatch_option": "auto",
  "http_header": {
    "additionalProp1": {}
  },
  "http_threshold_value": 0,
  "http_threshold_option": "minute",
  "ids": [
    "string"
  ]
}
```

--------------------------------

### Example Query Parameters with Time Placeholders

Source: https://docs.guardsix.com/integrations/universal-rest-api-fetcher/ingest-logs-in-siem.md

Utilize `{{start}}` and `{{end}}` placeholders in query parameters for time-based filtering. These placeholders dynamically insert the fetch window's start and end times into the request.

```text
StartTimestamp = {{start}}
EndTimestamp = {{end}}
```

--------------------------------

### AgentX Client Installation to Custom Path (OSSEC and Osquery)

Source: https://docs.guardsix.com/agentx/plan-and-deploy/deploy-endpoints/install-agentx-client-on-windows-mass-sccm.md

Install Osquery and OSSEC components to a custom directory. Specify the desired installation path using INSTALL_DIR. Replace 'x.x.x.x' with your Logpoint IP address.

```bash
msiexec /i "AgentX_Client_windows_1.4.1.msi" ADDLOCAL=OsqueryFeature MANAGER_ADDRESS=x.x.x.x INSTALLATION_TYPE=custom INSTALL_DIR="D:\AgentX_Client" /qn
```

--------------------------------

### Plugin Configuration Request Body

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/pluginconfiguration.md

Example JSON payload for editing a plugin configuration's installation.

```json
{
    "data": {
        "file_location": "private",
        "files": {
            "file_key_1": "file_name_1.txt",
            "file_key_2": "file_name_2.crt"
        },
        "key2": "value2"
    }
}
```

--------------------------------

### Processing Policy Get Success Response

Source: https://docs.guardsix.com/director/automate-with-apis/director-console-api-documentation/processingpolicy.md

Example of a successful response when retrieving a single Processing Policy.

```json
{
    "active": true,
    "enrich_policy": "None",
    "id": "59099afa854ff52b6819a739",
    "norm_policy": "None",
    "policy_name": "test_processingpolicy7",
    "routing_policy": "590961d2d8aaa45aa5501ce2",
    "tid": ""
}
```

--------------------------------

### Linux Syslog Configuration Example

Source: https://docs.guardsix.com/siem/ingest-and-prepare-data/ingest-logs/ingest-with-built-in-collectors-and-fetchers.md

Provides an example of how to configure the syslog.conf file on a Linux system to forward logs to a remote Logpoint server.

```text
/etc/syslog.conf
*.*     @logserv.example.com:port
```

--------------------------------

### Greedy Match Definer Example

Source: https://docs.guardsix.com/siem/reference/list-of-definers.md

Use the 'all_max' definer for greedy matching (.*); it captures all content from the start to the end.

```regex
Greedy (".*"), captures all the contents to the end from where it has begun.
```
Tokens:
Raw