For AI agents: the docs index is at https://developers.katalon.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Katalon APIKatalon APIAPI ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
Developer GuidesRecipesAPI Reference
API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatformLog InKatalon API
API Reference
Log In

Get started

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

True Platform API (v2)

  • Execution
    • Schedules
      • List schedulesget
      • Get a scheduleget
      • Trigger a schedulepost
    • Test runs
      • Create and start a test runpost
      • Run a scheduled occurrence (deprecated compatibility action)put
      • Run a scheduled occurrence nowpost
      • Cancel a test runpost
      • List test runsget
      • Get test-run detailsget
      • Rerun a test runpost
    • Test results
      • List test results for a test runget
      • Get a test resultget
    • Logs and reports
      • List the jobs of a test runget
      • Get a job logget
      • Request a report filepost
      • Check if a report file is readyget
      • Download a report fileget
  • Test management
    • Test cases
      • Search test casesget
      • Get a test caseget
    • Test suites
      • Search test suitesget
      • Get a test suiteget
      • Search test-suite membershipget
    • Repositories
      • List repositoriesget
      • Search repositoriesget
      • Create, update, move, or delete test assetspost
    • Releases
      • Search releasesget
      • Create a releasepost
      • Get a releaseget
      • Update or close a releaseput
    • Sprints
      • Search sprintsget
      • Get a sprintget
    • Requirements
      • Search requirementsget
      • Get a requirementget
      • Get a requirement by external keyget
      • Link test cases to a requirementpost
      • Unlink test cases from a requirementdel
    • Defects
      • Find defectsget
  • Insights and integrations
    • Projects
      • List projectsget
    • Reports
      • List reportsget
      • Get report metadataget
      • Get report metadata by slugget
    • Quality insights
      • Query requirement insightspost
      • Query defect insightspost
      • Query configuration coveragepost
      • Query test-case insightspost
      • Query common failurespost
    • Test stability
      • Query test flakinesspost
      • Query test stabilitypost
    • Iterations
      • List report iterationsget
    • Issues
      • Get an ALM issueget
    • Attachments
      • Download an ALM attachmentget
    • Comments
      • Add an ALM issue commentpost
    • Manual runs
      • Find manual executionsget
    • Execution test cases
      • List execution-local test casesget
      • Get execution-local case contentget
    • Activity evidence
      • Find manual activity evidenceget
    • Stored metadata
      • List stored artifact metadataget
      • List stored document metadataget
  • TestCloud
    • Environments
      • List shared TestCloud environmentsget
    • Session artifacts and download links (v1)
      • List TestCloud session outputs (v1)get
      • Get a TestCloud session output (v1)get
    • Mobile App
      • Get upload URLget
      • Upload mobile appput
      • Create mobile apppost
      • Delete mobile appdel
      • List all mobile appsget
    • Mobile devices
      • List all device groupsget

True Platform API (v1)

  • 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
  • Search test-related objects via API
    • Get test object via searchpost
  • File handling
    • Download a file by file-handle IDget
    • Allocate file upload URLsget
  • Visual checkpoints
    • Get checkpoint pixel detailsget
    • Set a checkpoint review statuspost
    • Rename a baseline collection groupput
  • 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
Powered by 

TestCloud

Find TestCloud environments, read session outputs, and manage mobile apps and devices for TestCloud runs. Start with Find shared TestCloud environments with the API.

Updated about 4 hours ago


List stored document metadata
Environments
Did this page help you?

Updated about 4 hours ago


List stored document metadata
Environments
Did this page help you?