1. Home
  2. On-premises 6.0
  3. Guides
  4. Concepts
  5. Tools
  6. References
    1. Apache Spark
    2. Built-in Functions
    3. Incorta Component SDK
    4. Incorta Connector SDK
    5. Connectors
    6. Public API
      1. API v1
      2. API v2 (6.0+)
    7. Security
    8. Visualizations
    9. Other
  7. Integrations
  8. Data applications
  9. Releases

References → 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.

Note

You have to use the HTTPS scheme to be able to successfully run the API endpoints.

There are two versions of Incorta public API: Public API v1 and Public API v2. Public API v1 is available in all releases starting with 5.0 while Public API v2 is available starting 6.0. The 6.0 release introduces a new authentication process that Public API v1 isn't compatible with. Thus, you can't use the 6.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 6.0 or later releases and use it to create new access tokens for Public API v1 as usual.

For details, refer to Public API v1 and Public API v2.