1. Cloud
  2. Guides
  3. Tours
  4. Concepts
  5. Tools
    1. Alert Editor
    2. Analyzer
    3. Avro Extractor Tool
    4. Business Schema Designer
    5. Business Schema Manager
    6. CMC Logs Manager
    7. CMC Monitoring
    8. CMC Scheduler
    9. CMC Tenant Manager
    10. Content Manager
    11. Dashboard Filters Manager
    12. Dashboard Manager
    13. Data Agent
    14. Data Lineage Viewer
    15. Data Lineage Viewer v2
    16. Data Manager
    17. Formula Builder
    18. Inspector Tool
    19. Join Editor
    20. Load Job Details Viewer
    21. Load Job Viewer
    22. Load Plan DAG Viewer
    23. Model Update Viewer
    24. Notebook Editor
    25. Profile Manager
    26. Public API
    27. Query Plan Viewer
    28. Scheduler
    29. Schema Designer
    30. Schema Diagram Viewer
    31. Schema Manager
    32. Schema Wizard
    33. Security Manager
    34. Table Editor
    35. Upload Service Command Line Interface (CLI)
  6. References
  7. Integrations
  8. Data applications
  9. Releases

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 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 2023.4.0. Thus, you can't use the 2023.4.0 release 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 2023.4.0 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 or token for your corresponding user account within Incorta. The steps to generate an API key or token vary according to the API version. For details, refer to Public API v1 or Public API v2 depending on your Incorta Cloud release.