# Automox

{% hint style="warning" %}
This feature is in Early Release/BETA. Please contact your Epiphany Systems support or sales contact to learn more.
{% endhint %}

{% hint style="warning" %}
This document is under construction. Please excuse our dust.
{% endhint %}

## About This Document

This guide details the steps necessary to connect Automox appliances to the Epiphany Intelligence Platform.  The Epiphany Intelligence Platform leverages data from patch management appliances to provide greater visibility into the organization’s applications, hosts, and potential vulnerabilities. 

## **Overview**

Automox instances allow API access by virtue of an API key, which can be created in the Management Console by an admin. The permissions granted to the API key will be limited to those assigned to the delegated user’s role. 

The Epiphany Intelligence Platform requires read-only access to the Automox API, which is one of the default roles within the system.  

There are two options to this end; either is acceptable:  

* **Option 1 - new user:** Create a new user designated for use by Epiphany, and generate an API key.
* **Option 2 - existing user:** Leverage an existing user and follow the steps to generate an API key.

## **Version Compatibility**

* **Epiphany Collector**: Version 1.0 and later.
* **Automax:** Automox API Update 10/04/2021 and later.

## **Prerequisites**

* [ ] Access to the Automox Management Console (web UI)
* [ ] Ability to create a user, or access to an existing user with the Read Only role

## **What is Needed for Integration**

* [ ] The Organization ID
* [ ] The API Key

[Legal Notice](/technical-documentation/legal-notice.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.reveald.com/technical-documentation/data-sources-early-access/automox.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.