---
title: API
slug: api
docTags: 
createdAt: 2026-07-23T16:08:13.972Z
---

:::hint{type="info"}
Navigate to the sidebar menu: [Integrations](docId\:dqCi75YZYByKVZLFcBztL)** > API**.
:::

## Overview

The** API module** is designed to manage programmatic **access **to your **dashboard**. It allows developers and system administrators to securely **connect **custom applications, **automate **repetitive tasks, and **extract **data using our application programming **interface**.

:::hint{type="info"}
**How it works: **The system **generates **a unique** authentication key** tied to your specific **administrative **user and role. By utilizing this **key**, external scripts and services can **interact **with the platform **securely **without requiring manual login via the web interface.
:::

## Interface Overview

The** interface features** an informational banner containing helpful **resources**, followed by a detailed **list **of your available **API credentials**.

### Documentation Banner

Use this top **section **to access **detailed **technical **resources**.

| **Interface Element**             | **Description & Focus**                                                                                                                                                                                                                                               |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Consult the API documentation** | An informational **banner **providing a direct link to the comprehensive developer **documentation**, featuring technical details and usage **examples**. You can **dismiss **this banner by **checking **the Don't show again **box**. |

### List View

The main table **displays **your** active API** keys and their usage **statistics**.

| **Interface Element** | **Description & Focus**                                                                                                                                                                                               |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Username & Key**    | Displays the name of the **administrator **above their unique **alphanumeric **API **credential**. Click the Copy **button **to securely **copy **the text to your clipboard. |
| **Status**            | A label **indicating **whether the API key is currently active and ready to authenticate requests.                                                                                                          |
| **Role**              | Shows the specific **permission **level **associated **with the generated **API **key, ensuring programmatic actions are bound by** role based** access controls.             |
| **Last used**         | **Indicates **the exact **date **the API key was most recently **utilized **to communicate with the **system**.                                                                         |
| **Created on**        | Shows the **original **generation **date **of the **API **credential.                                                                                                                   |

## Configuration & LogicSecure Automation

**API keys** carry the exact same **privileges** as the user role they are **assigned **to. **Safeguard **these credentials carefully as they provide direct **access **to your platform configurations. You can use these keys in conjunction with the official API **documentation** to automate policy **deployments**, synchronize network **updates**, or fetch security **logs **directly into your preferred **monitoring systems**.