# Add API Key

## Getting Here <a href="#getting-here" id="getting-here"></a>

**Settings > User Management > API Keys > Add API Key button**

## Add New API Key Form <a href="#add-new-api-key-form" id="add-new-api-key-form"></a>

The **Add New API Key** form allows users to create and configure API keys for accessing system integrations and automation.

***

### Form Fields <a href="#form-fields" id="form-fields"></a>

1. **Application Name\***
   * **Description**: A required field to specify the name of the application or purpose for which the API key is being created.
   * **Required**: Yes
2. **Description**
   * **Description**: An optional field to provide additional context or notes about the API key’s usage.
   * **Required**: No
3. **Role\***
   * **Description**: Defines the access permissions for the API key.
   * **Options**:
     * `admin`: Provides full administrative privileges.
     * `readonly`: Grants read-only access.
   * **Control**: Dropdown menu to select the role.
   * **Required**: Yes

***

### Form Actions <a href="#form-actions" id="form-actions"></a>

1. **SAVE**
   * **Description**: Saves the API key configuration and creates the new key.
2. **CANCEL**
   * **Description**: Discards changes and closes the form without creating a new API key.

***

### Notes <a href="#notes" id="notes"></a>

* Fields marked with an asterisk (\*) are **mandatory**.
* Use descriptive and clear **Application Names** to identify the API key's purpose.
* Carefully select the **Role** to limit access as necessary:
  * Use `readonly` for minimal permissions.
  * Use `admin` only for full administrative access when required.