Skip to main content

Katalon API keys in Katalon Studio

Use of Katalon API Keys in Katalon Studio​

With API Keys generated from Katalon TestOps, you can:
  • Install plugins from Katalon Store in console mode. See Use plugins in console mode.
  • Integrate Katalon Studio with Katalon TestOps in console mode. See Upload Test Results to Katalon TestOps from Katalon Studio.
  • Use API Keys to represent your credentials to integrate Katalon TestOps with other platforms like Jira and Jenkins, or to create a test environment with Circle Continous Integration (CircleCI), Amazon Elastic Kubernetes Service (Amazon EKS), or Local Agent.
In the command builder, both command-line options are accepted: -apiKey=<Your_API_Key> and -apikey=<Your_API_Key>.

Generate Katalon API keys​

In Katalon Studio, you can view your API Keys in the command builder. To generate, use, and remove an API Key, you need to navigate to the Katalon API Keys section in Katalon TestOps. For detailed instructions, refer to this document: API Keys.