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
    • 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
    • Stored files
      • List stored artifact metadataget
      • List stored document metadataget
  • Test management
    • Test cases
      • Search test casesget
      • Get a test caseget
    • 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
    • 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
      • Search defectsget
  • Execution
    • Schedules
      • List schedulesget
      • Get a scheduleget
      • Run a schedule now (no run ID)post
    • Test runs
      • 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 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
    • Manual runs
      • List manual runsget
    • 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
    • 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
      • 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
Powered by 

Files and visual checkpoints

v1 routes for file handles and visual checkpoints on your tenant host. See Legacy Files and Visual Checkpoints API (v1).

Updated about 7 hours ago


Get test object via search
File handling
Did this page help you?

Updated about 7 hours ago


Get test object via search
File handling
Did this page help you?