> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threataware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Syxsense

> Connect ThreatAware to Syxsense to monitor endpoint security and vulnerability management

## Overview

The Syxsense integration enables ThreatAware to collect endpoint security and vulnerability management data from your Syxsense instance. This integration provides visibility into endpoint compliance, vulnerabilities, and security posture across your organisation.

<Info>
  **Connection Method**: API Key
  **Setup Time**: 10 minutes
  **Access Required**: Syxsense Administrator account
</Info>

## Data collected

The Syxsense integration provides:

* Endpoint vulnerability data
* Patch compliance information
* Security configuration status
* Endpoint inventory and asset data

## Use cases

<CardGroup cols={2}>
  <Card title="Endpoint Vulnerability Management" icon="exclamation-triangle">
    Track vulnerabilities across endpoints and verify patch compliance
  </Card>

  <Card title="Security Posture Monitoring" icon="shield-check">
    Monitor endpoint security configurations and compliance status
  </Card>

  <Card title="Patch Management Validation" icon="package">
    Verify patches are installed and systems are up to date
  </Card>

  <Card title="Compliance Reporting" icon="file-check">
    Generate reports showing endpoint security coverage and compliance
  </Card>
</CardGroup>

## Setup instructions

<Steps>
  <Step title="Log in to ThreatAware">
    Access the ThreatAware dashboard. Navigate to **Settings** > **Systems** and search for "Syxsense" using the search bar.
  </Step>

  <Step title="Click Connect">
    Click the **Connect** button to start the integration setup. A pop-up window will appear with credential input fields.
  </Step>

  <Step title="Log in to Syxsense Console">
    Log in to the [Syxsense Console](https://www.syxsense.com) with an administrator account. You'll need to navigate to the API settings to generate a key.
  </Step>

  <Step title="Navigate to API Settings">
    In the Syxsense Console, click **Settings** in the main navigation and select **API Access**. This section contains API key generation options.
  </Step>

  <Step title="Generate API Key">
    In the API Access section, click **Create** or **Generate New Key**. The new API Key will be displayed. Copy the API Key immediately and store it securely.

    <Warning>
      Save the API key immediately. Some providers do not allow you to retrieve it again after creation.
    </Warning>
  </Step>

  <Step title="Input API Key in ThreatAware">
    Return to the ThreatAware connection pop-up and enter the **API Key** generated in Syxsense. Click the **Authorize** button to complete the integration.
  </Step>

  <Step title="Verify Connection">
    After authorising, verify the integration is working correctly.

    * Check that the **Integration Status** in ThreatAware shows as **Active**
    * Wait 5-10 minutes for initial data synchronization
    * Verify endpoint and vulnerability data is appearing in ThreatAware
  </Step>
</Steps>

## Required credentials

<AccordionGroup>
  <Accordion title="API Key" icon="key">
    **Field Name**: Syxsense API Key
    **Type**: String (sensitive)
    **Description**: The API key generated in the Syxsense Console

    <Tip>
      Store this key securely in your organisation's password manager. It provides access to your Syxsense endpoint data and should be treated as a sensitive credential.
    </Tip>
  </Accordion>
</AccordionGroup>

## Verification and testing

After setup, verify the integration is working correctly:

1. **Check Integration Status**
   * Navigate to **Settings** > **Systems** in ThreatAware
   * Confirm the Syxsense integration shows **Active** status
   * Check the last sync timestamp

2. **Verify Data Collection**
   * Wait 10 minutes for the initial data poll
   * Look for endpoint and vulnerability data appearing in ThreatAware
   * Verify data matches your Syxsense instance

3. **Test Queries**
   * Create a test query to filter endpoints by vulnerability status
   * Verify the results match your Syxsense data
   * Search for specific endpoints to confirm data accuracy

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid API Key Error" icon="triangle-exclamation">
    **Symptoms**: Integration status shows authentication failure

    **Solutions**:

    * Verify the API Key is correctly copied without extra spaces
    * Ensure the key hasn't expired
    * Confirm the key is still valid in the Syxsense console
    * Try generating a new API Key if the existing one appears invalid
    * Check that the key has the necessary permissions configured
  </Accordion>

  <Accordion title="Permission Errors" icon="ban">
    **Symptoms**: Integration connects but limited or no endpoint data appears

    **Solutions**:

    * Verify the API Key has the necessary permissions configured in Syxsense
    * Ensure the key was generated by an administrator account
    * Check that the key has permission to access endpoint and vulnerability data
    * Review Syxsense API documentation for required permissions
    * Contact Syxsense support if data access issues persist
  </Accordion>

  <Accordion title="No Data Appearing" icon="database">
    **Symptoms**: Integration shows active but no endpoint data is visible

    **Solutions**:

    * Verify endpoints are actually managed in your Syxsense instance
    * Wait at least 10 minutes for initial data synchronization
    * Check that vulnerabilities and compliance data exist in Syxsense
    * Confirm the API Key has permission to access all endpoints
    * Review Syxsense instance to ensure it contains data to sync
    * Contact support if data collection continues to fail
  </Accordion>

  <Accordion title="Intermittent Connectivity Issues" icon="wifi-slash">
    **Symptoms**: Integration works sometimes but fails intermittently

    **Solutions**:

    * Check your network connectivity to Syxsense
    * Verify Syxsense service status and availability
    * Confirm firewall rules allow outbound HTTPS (443) to Syxsense
    * Check for API rate limiting in Syxsense settings
    * Review ThreatAware logs for detailed error information
  </Accordion>
</AccordionGroup>

## API permissions reference

The API Key should be configured with permissions to access:

* Endpoint inventory and asset information
* Vulnerability and patch data
* Security compliance status
* Configuration management data

For detailed permission information, refer to the [Syxsense Documentation](https://www.syxsense.com).

## Additional resources

<CardGroup cols={2}>
  <Card title="Syxsense Documentation" icon="book" href="https://www.syxsense.com">
    Official Syxsense documentation for API configuration and troubleshooting
  </Card>

  <Card title="ThreatAware Support" icon="life-ring" href="mailto:help@threataware.com">
    Contact ThreatAware support for integration assistance
  </Card>
</CardGroup>

## Best practices

<Tip>
  **Credential Management**

  * Create a dedicated API Key for ThreatAware integration
  * Store the API Key securely in your organisation's password manager
  * Rotate API keys annually or per your security policy
  * Document which administrators can generate API keys
  * Monitor for authentication failures in ThreatAware regularly
</Tip>

<Tip>
  **Security Considerations**

  * Grant only the minimum API permissions necessary for data collection
  * Regularly review API key usage in Syxsense logs
  * Disable unused API keys to reduce exposure
  * Follow your organisation's least privilege principles
  * Monitor for unusual API access patterns that could indicate compromise
</Tip>
