Jump to Content
API Reference
Documentation
Community
Academy
Platform
API Reference
API Reference
Documentation
Community
Academy
Platform
Log In
API Reference
Log In
API Reference
Authentication
All
Pages
Start typing to search…
JUMP TO
KATALON API REFERENCE
Katalon API Reference
Authentication
Find ID variables for API calls
Errors
Rate Limit
TestOps API Documentation
Katalon TestOps API
External Issue
Map/link test case to a Jira issue
post
Agent
Get a local agent
get
Updates the threshold for local agent
put
Git Projects
Get a Git test project
get
Create a Git test project
post
Update a Git test project
post
Refresh test suite collections of a Git test project
post
Delete a Git test project
del
Project
Get a project
get
Get all projects
get
Build
Create a build
post
Update a build
put
Delete a build
del
Release
Create a release
post
Update a release
put
Test Result
Get a test result
get
Schedule
The scheduler object
The smart scheduler object
The run configuration object
Retrieve a scheduled execution
get
Create a schedule
post
Create and save a scheduled configuration
post
Create and trigger a schedule
post
Link a schedule to a release
post
Link a schedule to a build
post
Unlink a schedule from a release
post
Trigger a schedule
put
Delete a schedule
del
Test Run
Get test runs
get
Download all uploaded files of a test run
get
Export and download a test run
get
Link a test run to a build
post
Link a test run to a release
post
Unlink a test run from a release
post
Re-run a test run
post
Terminate a test run in progress
post
Delete test run
del
Test Suite
Get details of a test suite
get
Create a test suite
post
Update a test suite
post
Delete a test suite
del
Test Case
Get details of a test case
get
Update a test case
post
TESTCLOUD API DOCUMENTATION
Mobile App
Get upload URL
get
Upload mobile app
put
Create mobile app
post
Delete mobile app
del
List all mobile apps
get
TESTCLOUD API DOCUMENTATION (LEGACY)
Katalon TestCloud API
Mobile Apps
Get upload URL (Legacy)
get
Create mobile app (Legacy)
post
Delete mobile app (Legacy)
del
Get mobile apps by organization ID (Legacy)
get
SEARCH
Search test-related objects via API
Get test object via search
post
Upload app
Getting Started With Your API
execution-env-svc API
Mobile Device Resource
List all device groups
get
Powered by
Authentication
Ask AI
Learn how to authenticate your access to the Katalon API.
