1. Home
  2. Latest Release Docs
  3. Guides
  4. Concepts
  5. Tools
    1. Alert Editor
    2. Alias Sync Tool
    3. Analyzer
    4. Apache Parquet Merge Tool
    5. Avro Extractor Tool
    6. Business Schema Designer
    7. Business Schema Manager
    8. Cluster Management Console
    9. CMC Logs Manager
    10. CMC Monitoring
    11. CMC Patch Manager
    12. CMC Scheduler
    13. CMC Tenant Manager
    14. Command Line Interface
    15. Content Manager
    16. Dashboard Filters Manager
    17. Dashboard Manager
    18. Data Agent
    19. Data APIs for External Notebooks
    20. Data Lineage Viewer v2
    21. Data Manager
    22. Formula Builder
    23. Inspector Tool
    24. Join Editor
    25. Load Job Details Viewer
    26. Load Plan DAG Viewer
    27. Model Update Viewer
    28. Notebook Editor
    29. Profile Manager
    30. Public API
    31. Query Plan Viewer
    32. Scheduler
    33. Schema Designer
    34. Schema Diagram Viewer
    35. Schema Manager
    36. Schema Wizard
    37. Security Manager
    38. Table Editor
    39. Tenant Management Tool
    40. Upload Service Command Line Interface (CLI)
    41. Versioning Migration Tool
  6. References
  7. Integrations
  8. Data applications
  9. Release Notes
  10. Incorta Premium

Tools → Public API

Incorta’s public application programming interface (API) allows developers to interact with data within Incorta for programmatic uses. The power of being able to access data programmatically opens the door to many new uses of the application. Incorta receives API endpoint request payloads and returns response payloads in JSON. You must use the HTTPS scheme to be able to successfully run the Public API endpoints.

New version available

Starting the 2023.4.0 Cloud release and the 6.0 On-Premises release, Public API v2 is available with seamless and enhanced authentication.

The previous version, Public API v1, will be available as well but it isn't compatible with the new authentication introduced in these releases. Thus, you can't use these releases to generate new API keys or renew existing ones that are used in Public API v1. However, you can refresh existing access tokens, or you can use the latest API key that you generated before upgrading to these or later releases and use it to create new access tokens for Public API v1 as usual.

To access Incorta public API (v1 or v2), the Super User or a user with the SuperRole has to enable public API access for your account. In addition, you must generate an API key for your corresponding user account within Incorta. For details, refer to Public API v1 or Public API v2.