References → Public API v1
Overview
The first version of Incorta public API (Public API v1) is available in all cloud releases. This version isn't compatible with the new authentication introduced in the 2023.4.0 Cloud release and the 6.0 On-Premises release. Thus, you can't use thees releases or later 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.
For information about how to manage the legacy API keys, refer to Tools → Public API on 5.2 documentation or References → Public API v1 on the Cloud 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.
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
Use the HTTPS or HTTP scheme according to your installation. You must use the HTTPS scheme to successfully run the API endpoints on Cloud installations.
The following are the available endpoints in Public API v1:
- Configurations
- Get SQLi Connection (This endpoint is available on Cloud installations only.)
- Dashboard Schedulers
- Dashboards
- Query
- Schema
- Tokens
- Users