# Armis

{% 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 %}

## A**bout This Document**

This guide details the steps necessary to connect Armis to the Epiphany Intelligence Platform. The Epiphany Intelligence Platform leverages data from tools such as Armis to provide greater visibility into the network exposures in your environment.

## **Overview**

Armis allows API access by virtue of an API key, which can be created in the Armis management console by an individual user. The permissions granted to the API key will be limited to those of the user associated with that key.

Epiphany only requires read-only rights to the Armis Dashboard, which is a default role within the system when adding a new user.

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

* Create a new user who is designated for use by Epiphany, and generate an API key.
* Leverage an existing user and follow the steps to generate an API key.

## **Version Compatibility**

* **Epiphany Site Collector:** Epiphany Collector Version 1.0 and later.
* **Armis**: Armis API v1 or later.

## **Prerequisites**

* [ ] Access to the Armis Dashboard UI.
* [ ] Ability to create a user, or access to an existing user with a read-only role.

## **What is Needed for Integration**

* [ ] The Armis API key.
* [ ] The URL for the Armis instance.

[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/armis.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.