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

# Armis

> Connect Armis to KODE OS for asset data

> Connect Armis to KODE OS for asset data integration

## Overview

Use this integration to connect Armis asset inventory to KODE OS. You discover devices and IT/OT assets over REST for unified visibility alongside building systems.

| Property            | Value    |
| ------------------- | -------- |
| **System Type**     | Asset    |
| **Communication**   | REST     |
| **Collection**      | Pull     |
| **Collection Mode** | SNAPSHOT |

## Supported Capabilities

* Discover Devices & Points
* Discover Assets

## Prerequisites

* An active account with Armis and access to their API or developer portal
* API key or token from the Armis platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Armis platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it when configuring the connector in KODE OS

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Armis**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field       | Required | Type     | Description                                             |
| ----------- | -------- | -------- | ------------------------------------------------------- |
| **URL**     | Yes      | text     | The base URL or IP address of the external system       |
| **Site ID** | Yes      | text     | The site identifier in the external system              |
| **API Key** | Yes      | password | The API key for authenticating with the external system |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Armis system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## What Data You Get

### Alarms

Alert and fault notifications including alarm name, priority, status, timestamps, device association, and acknowledgment state

KODE OS maps Armis data to these standard fields:

| KODE Field       | Source Field                  | Notes                |
| ---------------- | ----------------------------- | -------------------- |
| **id**           | `alertId`                     | --                   |
| **name**         | `type`                        | --                   |
| **description**  | `description`                 | --                   |
| **priority**     | `severity`                    | --                   |
| **status**       | `status`                      | --                   |
| **createdAt**    | `time`                        | --                   |
| **updatedAt**    | `lastAlertUpdateTime`         | --                   |
| **customFields** | `(custom fields)`             | custom fields object |
| **deviceId**     | `String.join(", ", deviceIds` | --                   |
| **deviceId**     | `String.join(", ", deviceIds` | conditional          |

### Polling Schedule

* **Asset** -- Default polling: 5 minutes (min: 5 minutes, max: 30 minutes)
* **Alarm**

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Use Cases

Once connected, this integration enables you to:

* Centralize Armis data in your building operations dashboard
* Correlate data from this system with other building systems for comprehensive analytics

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Ensure the API key or token is valid and has not been revoked or expired in the Armis platform.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Armis system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Armis API.
  </Accordion>
</AccordionGroup>