For AI agents: visit https://developers.katalon.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Katalon APIKatalon APIAPI ReferenceDocumentationCommunityAcademyPlatform
API Reference
API ReferenceDocumentationCommunityAcademyPlatformLog InKatalon API
API Reference
Log In

KATALON API REFERENCE

  • Katalon API Reference
    • Authentication
    • Find ID variables for API calls
    • Errors
    • Rate Limit

True Platform API Documentation

  • Katalon True Platform API
    • External Issue
      • Map/link test case to a Jira issuepost
    • Agent
      • Get a local agentget
      • Updates the threshold for local agentput
    • Git Projects
      • Get a Git test projectget
      • Create a Git test projectpost
      • Update a Git test projectpost
      • Refresh test suite collections of a Git test projectpost
      • Delete a Git test projectdel
    • Project
      • Get a projectget
      • Get all projectsget
    • Build
      • Create a buildpost
      • Update a buildput
      • Delete a builddel
    • Release
      • Create a releasepost
      • Update a releaseput
    • Test Result
      • Get a test resultget
    • Schedule
      • The scheduler object
      • The smart scheduler object
      • The run configuration object
      • Retrieve a scheduled executionget
      • Create a schedulepost
      • Create and save a scheduled configurationpost
      • Create and trigger a schedulepost
      • Link a schedule to a releasepost
      • Link a schedule to a buildpost
      • Unlink a schedule from a releasepost
      • Trigger a scheduleput
      • Delete a scheduledel
    • Test Run
      • Get test runsget
      • Download all uploaded files of a test runget
      • Export and download a test runget
      • Link a test run to a buildpost
      • Link a test run to a releasepost
      • Unlink a test run from a releasepost
      • Re-run a test runpost
      • Terminate a test run in progresspost
      • Delete test rundel
    • Test Suite
      • Get details of a test suiteget
      • Create a test suitepost
      • Update a test suitepost
      • Delete a test suitedel
    • Test Case
      • Get details of a test caseget
      • Update a test casepost

TESTCLOUD API DOCUMENTATION

  • Mobile App
    • Get upload URLget
    • Upload mobile appput
    • Create mobile apppost
    • Delete mobile appdel
    • List all mobile appsget

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 searchpost

Upload app

  • Getting Started With Your API

execution-env-svc API

  • Mobile Device Resource
    • List all device groupsget
Powered by 

External Issue

The External Issue resource allows you to access endpoints and connect test cases with JIRA tickets.

Methods

  • Map/link test case to a Jira issue (POST)

Updated 3 months ago


Katalon True Platform API
Map/link test case to a Jira issue
Did this page help you?

Updated 3 months ago


Katalon True Platform API
Map/link test case to a Jira issue
Did this page help you?
    • Methods