---
title: "Create an API Key"
slug: "create-an-api-key"
updated: 2026-10-04T10:53:47Z
published: 2026-10-04T10:53:47Z
canonical: "support.controlup.com/create-an-api-key"
---

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

# Create an API Key

REST API Reference

Visit [https://api.controlup.io/reference](https://api.controlup.io/reference) for full details about ControlUp's REST APIs.

In a ControlUp Hybrid Cloud environment, you can use API authentication tokens (API Keys) to authenticate to your VDI and DaaS organization. If you use PowerShell cmdlets from the [ControlUp Automation module](https://www.powershellgallery.com/packages/ControlUp.Automation/1.0.3) to deploy components of the Real-Time DX Console, an API Key is required to:

- Install a ControlUp Monitor on both domain-joined and non-domain-joined machines in your organization.
- Install a ControlUp Agent and automatically register it with your organization.

You create an API Key with our web interface ([app.controlup.com](http://app.controlup.com)) and store it in a local profile. The local profile is saved in a user profile, ensuring that only the profile owner can access the API Key. This enables you to conveniently run PowerShell cmdlets without needing to provide the API Key each time.

### Prerequisites

- You must be assigned the **DEX Admin** role in the Real-Time Console.
- You must be assigned the **Manage API Keys** permission in the web interface. Note that the role/permissions must be assigned directly to the user who creates the API key, and not assigned indirectly via SSO groups.

### Create an API Key

**To create an API Key**:

1. Sign into [ControlUp's web interface](http://app.controlup.com).
2. Click your profile icon in the top-right corner > **API Key Management**. ![Profile icon clicked. API Key Management highlighted](https://cdn.document360.io/098100b7-b9da-4bea-b4b9-017140ab863e/Images/Documentation/AccessApiKeyManagement.png)
3. Click **+ Create new** and configure the API Key as needed.
4. Click **Create Api Key** and immediately copy it to a secure location. You can now use it as an API Key in your [PowerShell cmdlets](/v1/docs/90-powershell-cmdlets#installcumonitor).

### Store an API Key in a Profile

**To store an API Key in a user profile**:

1. Login as a user on the monitor machine and install the ControlUp Automation [module](https://www.powershellgallery.com/packages/ControlUp.Automation/1.0.3).
2. Open an elevated PowerShell window, run the **Set-CUAPIToken** cmdlet and provide the token (API Key) and profile name:

```powershell
Set-CUAPIToken -Token [APIKey] -Profile "[ProfileName]"
```

For example:

PowerShell

```powershell
Set-CUAPIToken -Token eyJhbGciOiJI... -Profile "MyProfile"
```

1. To verify if the profile was created and switched to, run the **Get-CUAPIProfile** cmdlet:

PowerShell

```powershell
PS C:\users\cuadmin> GET-CUAPIProfile
MyProfile
```

This creates a ***.cuapi*** file under **C:\Users\Username\AppData\Roaming\ControlUp**. The API Key is securely encrypted using DPAPI.

1. Optionally, to store an additional API Key in a separate user profile, run **Set-CUAPIToken** again with a different profile name. The new profile is added to the *.****cuapi*** file.
2. To verify the currently active profile, run **Get-CUAPIProfile**:

PowerShell

```powershell
PS C:\users\cuadmin> GET-CUAPIProfile
MySecondProfile
```

1. Run the [**Install-CUMonitor**](/v1/docs/install-cumonitor) cmdlet without the -Token parameter to use the API Key stored in the current profile.

### Troubleshooting

**Issue** The monitor installation fails with the error "Token verification failed".

**Reason** The API Key stored in the currently used profile is expired, incorrect, or has been revoked. Note the request ID and search for it in Splunk for more information.

**Solution**

1. Create a new API Key and store it in a new or existing user profile.
2. If multiple profiles exist, run **Set-CUAPIProfile** to switch to the profile you want.