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

True Platform API (v2)

  • Project setup
    • Organizations
      • List organizationsget
      • Get an organizationget
      • Update an organizationput
    • Projects
      • List projectsget
    • AUTs
      • List AUTsget
      • Create an AUTpost
      • Update an AUTput
      • Archive an AUTdel
      • Get an AUT's TrueTest statusget
      • List AUTs for a manual runget
    • AUT environments
      • List AUT environmentsget
      • Create an AUT environmentpost
      • Update an AUT environmentput
      • Archive an AUT environmentdel
      • Get an environment's TrueTest statusget
    • AUT project links
      • List AUT-project linksget
      • Link an AUT to the current projectpost
      • Attach a script repository to an AUT-project linkput
      • Unlink an AUT from the projectdel
    • Custom fields
      • List custom-field definitionsget
      • Create a custom-field definitionpost
      • Check custom-field definition capacityget
      • Update a custom-field definitionput
      • Archive a custom-field definitiondel
    • Secrets and variables
      • List secrets and variablesget
      • Create a secret or variablepost
      • Get a secret or variableget
      • Delete a secret or variabledel
    • Stored files
      • List stored artifact metadataget
      • List stored document metadataget
  • Test management
    • Test cases
      • Search test casesget
      • Get a test caseget
      • Get test-case contentget
      • Update test-case contentput
      • List test-case versionsget
      • Get the latest test-case versionget
      • Get a test-case versionget
      • Restore a test-case versionpost
      • List callers of a test caseget
      • Count callers of a test caseget
      • List cases called by a test caseget
      • Search callable test casesget
      • Resolve test-case referencespost
      • Get a test-case authoring draftget
      • Create or update a test-case authoring draftput
      • Delete a test-case authoring draftdel
      • List test-case linksget
      • List linked ALM test casesget
      • Export test casespost
      • Import ADO test casespost
      • Get test case dataget
      • Link a dataset to a test caseput
      • Unlink a dataset from a test casedel
      • Search test foldersget
      • List custom-field valuesget
    • Test suites
      • Search test suitesget
      • Get a test suiteget
      • List the test cases in a suiteget
    • Repositories
      • List repositories (deprecated)get
      • Search repositoriesget
      • Create, update, move, or delete test assetspost
      • List repository branchesget
      • List installed repositoriesget
      • Test a repository pathpost
    • Releases
      • Search releasesget
      • Create a releasepost
      • Get a releaseget
      • Update or close a releaseput
      • Export a release traceability matrixpost
      • Get release traceability scopeget
    • 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
      • Update a requirementpatch
    • Datasets
      • List datasetsget
      • Create a datasetpost
      • Get a datasetget
      • Update a datasetpatch
      • Delete a datasetdel
      • Get a dataset content referenceget
      • Prepare a dataset savepost
      • Duplicate a datasetpost
    • Test suite collections
      • List test suite collectionsget
      • List test suite collection entriesget
    • Tasks
      • Get a taskget
      • Cancel a taskpost
    • System field options
      • List system field definitionsget
      • Create a system field optionpost
      • Merge system field optionspost
      • Update a system field optionput
      • Delete a system field optiondel
    • Project variables
      • List project variablesget
      • List cases that use a variableget
    • Test plans
      • Get the latest test planget
    • Tags
      • Add tags to project assetspost
      • Replace tags on project assetsput
      • Remove tags from project assetsdel
      • Create a tag definitionpost
      • Update a tag definitionput
    • External issues
      • Link an ADO issue to a test casepost
      • Unlink an ADO issue from a test casedel
      • List linked external issuesget
      • List available ADO test casesget
      • List available external issuesget
    • Defects
      • Search defectsget
      • Unlink a defect from a test resultdel
  • Execution
    • Schedules
      • Delete saved schedulesdel
      • Update a saved scheduleput
      • Activate saved schedulespost
      • Deactivate saved schedulespost
      • List operating system optionsget
      • List browser optionsget
      • Search execution profilesget
      • List profile namesget
      • List visual test runsget
      • Update a baseline collection groupput
      • List schedulesget
      • Get a scheduleget
      • Run a schedule now (no run ID)post
    • Test runs
      • Get a scheduled occurrenceget
      • Update a test runput
      • Search test runsget
      • Get a test run (compatibility route)get
      • Link a test run to a release or sprintpost
      • Create and start a test runpost
      • Run a scheduled occurrence (deprecated)put
      • Run a scheduled occurrence nowpost
      • Cancel a test runpost
      • List test runsget
      • Get a test runget
      • Rerun a test runpost
    • Test results
      • List failure categoriesget
      • List project test resultsget
      • List test results for a test runget
      • Get a test resultget
    • Logs and reports
      • Get an uploaded fileget
      • List uploaded files for a test runget
      • 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
    • Manual runs
      • List manual runsget
      • End a manual runpost
      • List results in a manual runget
      • Update a manual test-case resultpost
    • Manual run test cases
      • List the test cases in a manual runget
      • Get the test-case content used in a manual runget
    • Manual run activity
      • List comments and status changes for a manual runget
    • Manual iterations
      • List iterations for a test caseget
      • List iterations in a manual runget
      • Get iteration progress for a manual runget
      • Get a manual iterationget
      • Get an iteration's result historyget
      • Start an iteration timerpost
      • Stop an iteration timerpost
      • Mark an iteration status without re-executionpost
    • TestCloud
      • TestCloud environments
        • List shared TestCloud environmentsget
      • TestCloud session outputs (v1 path)
        • List TestCloud session outputs (v1)get
        • Get a TestCloud session output (v1)get
      • TestCloud features
        • List TestCloud execution featuresget
      • TestCloud tunnels
        • List private-network tunnelsget
        • Get a private-network tunnelget
        • Delete a private-network tunneldel
      • TestCloud agents
        • List self-hosted agentsget
        • Get a self-hosted agentget
        • Update a self-hosted agentput
        • Delete a self-hosted agentdel
      • TestCloud executions
        • List TestCloud executionsget
      • TestCloud live sessions
        • Create a desktop live-session recordpost
      • TestCloud apps
        • Get a mobile app upload URLget
        • List mobile appsget
        • Create a mobile app recordpost
        • Get a mobile app download URLget
      • Mobile apps
        • Get upload URLget
        • Upload mobile appput
        • Create mobile apppost
        • Delete mobile appdel
        • List all mobile appsget
      • Mobile devices
        • List all device groupsget
  • Reports and insights
    • Reports
      • List reportsget
      • Get report by IDget
      • Get report by slugget
    • Quality insights
      • Query requirement insightspost
      • Query defect insightspost
      • Query configuration insightspost
      • Query test-case insightspost
      • Query common failurespost
    • Test stability
      • Query test flakinesspost
      • Query test stabilitypost
    • Iterations
      • List report iterationsget
  • ALM integration
    • ALM issues
      • Get an ALM issueget
    • ALM attachments
      • Download an ALM attachmentget
    • ALM comments
      • Add an ALM issue commentpost

True Platform API (v1)

  • v1 API overview
    • Authentication
    • Find ID variables for API calls
    • Errors
    • Rate Limit
  • 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
  • Files and visual checkpoints
    • 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 (legacy)
    • 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
  • CI result import
    • Register JUnit report metadatapost
    • Register Katalon report metadatapost
    • Register Katalon Recorder report metadatapost
    • Register multiple Katalon report filespost
Powered by 

Test management

Manage test cases, suites, folders, repositories, releases, sprints, requirements and defects. Start with Manage test cases and suites with the API.

Updated 21 days ago


List stored document metadata
Test cases
Did this page help you?

Updated 21 days ago


List stored document metadata
Test cases
Did this page help you?