Skip to main content

Katalon API Key in Katalon 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.

    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.

Generate a Katalon API Key​

To create a new API Key, follow these steps:

  1. Sign in to Katalon TestOps.
  2. Click on the Avatar icon at the top right corner.
  3. 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.

    Katalon API Key page
  4. Click Create API Key in the top right corner.

    The Create API Key box pops up.

  5. Enter a name for your key, select the expiration period, then click Create.
    Create API Key dialog
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.
  1. Go to your Katalon API Key page.

    You can see a list of all API Keys here.

  2. Click on the Copy icon of the API Key you want to use.
    Copy an API Key
  3. Paste the copied API Key to the required platform.

Remove a Katalon API Key​

Follow these steps to remove a Katalon API Key.
  1. Go to your Katalon API Key page.

    You can see a list of all API Keys here.

  2. Click on the Trash bin icon of the API Key you want to remove.
    Remove an API Key
  3. Click Delete to confirm your action.