Lakehouse Turbo REST API
This article describes how to use Exasol SaaS REST API with Lakehouse Turbo.
Introduction
Exasol SaaS provides a REST API that enables you to use RESTful commands to configure and manage replication in Lakehouse Turbo. You can interact with the REST API through the built-in Swagger UI , with a command line tool such as curl, or using an API client such as Postman or Insomnia.
All Lakehouse Turbo configuration and replication endpoints are defined in the Exasol SaaS OpenAPI specification .
Authentication
To use the REST API, you must first generate a personal access token (PAT). Personal access tokens function like regular OAuth access tokens. When interacting with the REST API on the command line or with an API client, you must add the token in the request header.
The personal access token must have the Database – use & operate
scope.
To learn more about how to create a PAT and about token scopes, see Personal access token.
Endpoints
Definitions of the endpoints in the REST API can be found in the Exasol SaaS OpenAPI specification . The endpoints for Lakehouse Turbo begin with dlhc-, for example, dlhc-activate.
Swagger UI is an interactive API console in Exasol SaaS that describes the available endpoints and allows you to execute commands directly from the UI after authenticating with your PAT. You can also generate REST commands in Swagger UI that you can copy and use in other interfaces.
To learn more, see Using Swagger UI.
In the Swagger UI, the Lakehouse Turbo endpoints (dlhc-) are in the Databases section.
Examples
To get the state of the Lakehouse Turbo application using curl on the command line:
$ curl -X GET "https://cloud.exasol.com/api/v1/accounts/sd1srE1bXZ22B9eNA20wj/databases/Database01/dlhc/engine" -H "accept: application/json" -H "Authorization: Bearer <my_personal_access_token>"
{
"state": "STARTED"
}
To learn more about how to use the Exasol SaaS REST API, see Exasol SaaS REST API.
