1. Home
  2. Other Releases
  3. On-premises 6.0
  4. Guides
  5. Concepts
  6. Tools
  7. 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
  8. Integrations
  9. Data applications
  10. Releases

References → Public API v1

Overview

The first version of Incorta public API (Public API v1) is available in all releases starting with 5.0. This version isn't compatible with the new authentication introduced in 6.0. 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 information about how to manage the legacy API keys, refer to Tools → Public API on 5.2 documentation.

Public API v1 endpoints

The first function of the public API is to generate and refresh your access tokens. These tokens have an expiration time and are refreshed through an endpoint request. Once you generate your access and refresh tokens, you can use the other API endpoints to request data from Incorta. Your level of data access through the API is determined by the user account that generated the API key.

Note

All Incorta API endpoint’s timestamp values in both request and response payloads use the unix epoch timestamp in milliseconds.

You can access the Incorta public API user interface for your Incorta instance at the following URL:

https://<cluster_URL>/incorta/api or https://<server address>:<port>/incorta/api

Note

Use the HTTPS or HTTP scheme according to your installation.

The following are the available endpoints in Public API v1: