Katalon API Key in Katalon TestOps
- TestOps Legacy
- TestOps
You need to generate API Keys in Katalon TestOps in the following circumstances:
-
When you want to integrate Katalon Studio with Katalon TestOps in console mode. See Katalon Studio Integration.
-
When you want to integrate Katalon TestOps with other platforms such as Jira and Jenkins.
-
When you want to create a test environment such as CircleCI, AWS EKS, or create a local test environment with an agent.
- In the command-line generator in Katalon Studio, the command-line options for API Keys, including
-apiKey=<Your_API_Key>
and-apikey=<Your_API_Key>
are both accepted.
Generate a Katalon API Key
To create a new API Key, follow these steps:
-
Sign in to Katalon TestOps.
-
Click on the Avatar icon at the top right corner.
-
Go to User Settings > Katalon API Key or click on this link to access to the Katalon API Key page directly.
The Katalon API Key page appears.
-
Click Create API Key in the top right corner.
The Create API Key box pops up.
-
Enter a name for your key, select the expiration period, then click Create.
Result
You have successfully added a new API key.
Use a Katalon API Key
Follow these steps if you want to use your Katalon API Key:
-
Go to your Katalon API Key page.
You can see a list of all API Keys here.
-
Click on the Copy icon of the API Key you want to use.
-
Paste the copied API Key to the required platform.
Remove a Katalon API Key
Follow these steps to remove a Katalon API Key:
-
Go to your Katalon API Key page.
You can see a list of all API Keys here.
-
Click on the Trash bin icon of the API Key you want to remove.
-
Click Delete to confirm your action.
Result
You have successfully removed a Katalon API Key.
This section describes how to create and remove a Katalon API Key in Katalon TestOps.
Create a Katalon API Key
-
Log in to Katalon TestOps.
-
Click on your Profile at the top right corner > User Settings.
The Personal Integration tab appears by default.
-
Click on the Katalon API Key tab.

-
Click on Create API Key at the top right.
Input the following information:
- Key name: The label of the API Key.
- Expiration: Select the expiration period for the dropdown menu.
- Description: (Optional) Add a description for the API Key.
-
Click Create.
Result
You have successfully created a Katalon API Key.
Remove a Katalon API Key
-
Go to your Katalon API Key page.
You can see a list of all API Keys here.
-
Click on the Delete icon of the API Key you want to remove. It is represented by a trash bin icon.

- Click on Delete to confirm your action in the pop-up dialog.
Result
You have successfully removed a Katalon API Key.