API Keys in Splashtop Secure Workspace enable you to authenticate and authorize API requests, allowing you to interact with the system programmatically. This document provides an overview of the API Keys page and explains the available actions. There are two distinct types of API keys:
- Controller API Key: This type of API key is used to authenticate and authorize API requests for controlling and managing various aspects of the system programmatically. It allows you to interact with the system's functionalities and perform administrative tasks.
- Secrets API Key: This type of API key is specifically designed for accessing and managing secrets within the system programmatically. It provides the necessary authentication and authorization to read or write secrets, which are sensitive pieces of information stored securely.
Accessing the API Keys Page
To access the API Keys page and manage your API keys, follow these steps:
- Log in to your Splashtop Secure Workspace account using your credentials.
- Click on the user avatar located in the upper right corner of the UI.
- From the dropdown menu, select API Keys.
Viewing and Managing API Keys
On the API Keys page, you will see a list of your API keys. Each API key is identified by its unique Name and includes additional information such as the Description, Type, Date Created, and Modified By.
Here are the actions you can perform on Controller API key:
- Edit: Clicking the "Edit" button allows you to modify the Name of the API key. You can update the name and description to better reflect the purpose or usage of the API key.
- Delete: The "Delete" button allows you to remove the selected API key from the system. Please note that this action is irreversible and will permanently delete the API key.
Here are the actions you can perform on Secrets API keys:
- Edit: Clicking the "Edit" button allows you to modify the Name of the Secrets API key, modify the permission settings associated with the Secrets API key and modify the Attached Secret List
- Delete: The "Delete" button allows you to remove the selected Secrets API key from the system. Please note that this action is irreversible and will permanently delete the API key.
Managing your API keys is important to ensure the security and control of your system. You can edit or delete API keys as needed to maintain proper access and authorization controls for your API interactions. You should remove any keys that you do not recognize