Skip to content

Robot Management - Robot API Key

rpa_RobotManagement_RobotAPI_Key_Overview

Robot API keys are required during installation of a robot. The robot logs into the server with its API key.

Creating an API key

button_Create

To create a new, individual API key, click on the button Create.

rpa_RobotManagement_RobotAPI_Key_Create

After entering a name and a description, click on OK.

Copy to clipboard

Copy the API key to the clipboard by clicking on the Copy to clipboard icon next to the API key in the table. You can then insert the API key in the appropriate field of the installation procedure using a keyboard command or mouse context menu.

Edit

Click on the Edit icon to change the name and description of a Robot API Key.

Remove

Click on the Remove icon to delete a Robot API Key.

When you delete an API key, the system does not check whether the key is assigned to a robot. If you have deleted an API key that is in use, the robot can no longer log in to the X1 Server until a new API key is assigned.

Further information

The API key is assigned during installation and it can be changed using the X1 Bot Configurator.

An API key can be used simultaneously by multiple robots.