API ReferenceDocumentationCommunityAcademyPlatform
API Reference

Authentication

TestOps API supports HTTP Basic authentication.

There are two ways to authenticate API requests:

  1. Use your username and password; and
  2. Use your Katalon API key

Use Username and Password

Provide your Katalon username and password in the HTTP Authorization header of the request.

For example, you may send an HTTP request with the username and password admin:admin in the header value (encoded in Base64) as follows:

curl --request GET \
     --url https://testops.katalon.io/api/v1/test-cases/123 \
     --header 'accept: */*' \
     --header 'authorization: Basic YWRtaW46YWRtaW4=' # "admin:admin" encoded in Base64

Use Katalon API Key

To create an API key, follow this guide: Generate Katalon API key.

Enter your Katalon API key and leave out the username in the Authorization header.

For example, with the API key APIKEY, your HTTP request is as follows:

curl --request GET \
     --url https://testops.katalon.io/api/v1/test-cases/id \
     --header 'accept: */*' \
     --header 'authorization: Basic OkFQSUtFWQ==' # ":APIKEY" encoded in Base64