To make requests to the ControlUp for Desktops API, you must provide your API key as a bearer token in the authorization header. Read Create and Manage API Keys to learn how to create an API key.
After you add your API key, you can adjust any parameters for the endpoint and click Try it! to send the request.
Note about previous versions
As of December 9, 2024 the ControlUp for Desktops API supports API keys created in the DEX platform. Previously, you had to contact ControlUp Support to receive an API key. Using the new DEX API keys requires you to use a new base URL: https://api.controlup.com/edge/api.
Any scripts or programs you have created using the old API keys will continue to work, however, you can't send requests directly from the API documentation using your old API key.
We recommend that you update your scripts or programs to use the new API keys so you can create and manage API keys yourself and use DEX's permission scopes feature.
As a reminder, if you use your old API key:
- The API key must be send in the header
x-api-key - The base URL must be https://{tenantName}.sip.controlup.com/api