> ## 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.

# Automox

> Connect ThreatAware to Automox for patch management and endpoint compliance visibility

## Overview

The Automox integration enables ThreatAware to collect patch management and compliance data from your Automox console, providing visibility into endpoint security posture and patch deployment status.

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

## Data collected

The Automox integration provides:

* Patch deployment status
* Endpoint compliance information
* System vulnerability data
* Patch management metrics

## Use cases

<CardGroup cols={2}>
  <Card title="Patch Compliance Tracking" icon="shield-check">
    Monitor patch deployment status across your device fleet
  </Card>

  <Card title="Compliance Validation" icon="clipboard-check">
    Verify endpoints meet your patch management requirements
  </Card>

  <Card title="Vulnerability Management" icon="triangle-exclamation">
    Track and prioritize endpoint vulnerabilities
  </Card>

  <Card title="Risk Assessment" icon="chart-line">
    Generate reports on endpoint security posture
  </Card>
</CardGroup>

## Setup instructions

<Steps>
  <Step title="Log in to Automox Console">
    Access your [Automox Console](https://console.automox.com) with an administrator account.
  </Step>

  <Step title="Retrieve Organisational ID">
    * Look at the URL of your Automox console (e.g., `https://console.automox.com/org/1234`)
    * Your **Organisational ID** is displayed in the console's URL
    * Copy the Organisational ID for use in ThreatAware
  </Step>

  <Step title="Generate an API Key">
    * Navigate to **Settings** > **API Keys** in the Automox console
    * Click **Add** to create a new API key
    * Provide a descriptive name for the API key (e.g., "ThreatAware Integration")
    * Ensure the API key is assigned at least **Patch Administrator** permissions
    * Copy the generated **API Key**

    <Warning>
      Keep the API key secure. Store it in your organisation's password manager and do not share it with unauthorized users.
    </Warning>
  </Step>

  <Step title="Configure in ThreatAware">
    Complete the integration setup in ThreatAware:

    * Open ThreatAware and navigate to **Settings** > **Integrations**
    * Search for and select **Automox**
    * Enter the required information:
      * **Organisational ID**: The ID from the Automox console URL
      * **API Key**: The API key generated in the previous step
    * Click **Connect** to establish the integration
  </Step>

  <Step title="Verify Connection">
    After connecting, ThreatAware will begin polling data from Automox:

    * Check that the **Integration Status** shows as **Active**
    * Wait up to 1 hour for the initial data sync
    * Verify patch management data appears in device details
  </Step>
</Steps>

## Required credentials

<AccordionGroup>
  <Accordion title="Organisational ID" icon="building">
    **Field Name**: Automox Organisational ID
    **Type**: String
    **Description**: The unique identifier for your Automox organisation

    Located in the URL of your Automox console (e.g., `https://console.automox.com/org/1234`). Copy the numeric ID only.

    Example: `1234`
  </Accordion>

  <Accordion title="API Key" icon="key">
    **Field Name**: Automox API Key
    **Type**: Password (encrypted)
    **Description**: Authentication key for API access to your Automox account

    Generated in **Settings** > **API Keys** within the Automox console. Must have at least Patch Administrator permissions.

    <Tip>
      Create a dedicated API key for ThreatAware integration. This makes it easier to rotate keys and track usage.
    </Tip>
  </Accordion>
</AccordionGroup>

## Verification and testing

After setup, verify the integration is working correctly:

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

2. **Verify Data Collection**
   * Wait up to 1 hour for initial data collection
   * Search for a known device in ThreatAware
   * View device details to confirm patch management data is present

3. **Test Queries**
   * Create a test query to filter devices by patch compliance status
   * Verify the data matches your Automox console

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid Credentials Error" icon="triangle-exclamation">
    **Symptoms**: Integration fails to authenticate

    **Solutions**:

    * Verify the **Organisational ID** matches the one in your Automox console URL
    * Confirm the **API Key** is correct and has not expired
    * Ensure the API key was created with **Patch Administrator** or higher permissions
    * Check that no extra spaces were added when copying the credentials
  </Accordion>

  <Accordion title="Permission Denied" icon="ban">
    **Symptoms**: Integration connects but no data appears

    **Solutions**:

    * Verify the API key has **Patch Administrator** permissions in Automox
    * Confirm the API key scope includes all organisations you want to monitor
    * Check the Automox console for any audit logs indicating permission issues
    * Review [Automox API Documentation](https://developer.automox.com) for required permissions
  </Accordion>

  <Accordion title="Connection Timeout" icon="clock">
    **Symptoms**: Integration fails to connect or times out

    **Solutions**:

    * Verify the Automox console URL is accessible from your network
    * Check firewall rules allow outbound HTTPS (443) connections
    * Confirm your internet connection is stable
    * Test the URL in a browser to ensure it's reachable
  </Accordion>

  <Accordion title="No Data After 1 Hour" icon="database">
    **Symptoms**: Integration shows active but no data appears

    **Solutions**:

    * Verify you have devices enrolled in Automox
    * Confirm the API key has access to view devices in Automox
    * Wait additional time for the first data sync to complete (up to 2 hours)
    * Review ThreatAware integration logs for specific errors
    * Contact Automox support if issues persist
  </Accordion>
</AccordionGroup>

## Additional resources

<CardGroup cols={2}>
  <Card title="Automox API Documentation" icon="book" href="https://developer.automox.com">
    Official Automox API documentation and reference materials
  </Card>

  <Card title="Automox Support" icon="life-ring" href="https://support.automox.com">
    Automox support portal for technical assistance
  </Card>
</CardGroup>

## Best practices

<Tip>
  **Credential Management**

  * Create a dedicated service account or API key specifically for ThreatAware
  * Document credentials in your organisation's password manager
  * Rotate API keys annually or per your security policy
  * Monitor integration status regularly to catch authentication failures early
</Tip>

<Tip>
  **Security Considerations**

  * Only grant the minimum required permissions (Patch Administrator)
  * Review audit logs in Automox periodically to monitor API usage
  * Do not share API keys with unauthorized users
  * Use your organisation's standard password management practices for storing credentials
</Tip>