Katalon API Key in Katalon TestOps
Generate a Katalon API Key
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.
Note: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.
-
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.
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 Notification Settings > Katalon API Key.
The Katalon API Key page appears.
Note:You can also click on this link, then sign in to have access to the Katalon API Key page directly.
-
Click Create API Key in the top right corner.
The Create API Key box pops up.
-
Enter a name for your key, then click Create.
You have successfully added a new API key.
Use a 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.
You have copied your API Key.
-
Paste the copied API Key to the required platform.
You can now use your 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 Trash bin icon of the API Key you want to remove.
-
Click Delete to confirm your action.
Warning:This action cannot be undone. You cannot use the API Key once it is deleted.