Starburst Enterprise REST API#
The Starburst Enterprise platform (SEP) REST API allows you to manage the following features with the scripting and automation tool of your choice:
The REST API can be used to programmatically create entities at any time in the lifecycle of your cluster. However, it is particularly useful during initial setup, when you must create a large number of entities all at once.
Specifically the initial configuration must include creation of a user with the
sysadmin role, since it is required to use the REST API. Create the user
through the UI, and then use it for further API requests for the initial setup.
This can then include further users, that have access to the REST API.
The REST API can be used for clusters secured with the PASSWORD authentication type only. API clients should
authenticate by using basic authentication (username and password), and sending
the authorization header with the base64-encoded value of
curl ... -H 'Authorization: Basic dFHzdDp0ZXN0'
Alternatively you can specify the username and password with the
curl ... -u 'username:password'
Entities and endpoints#
The REST API is split up into two separate groups of entities and endpoints, detailed in the following sections.
Built-in access control and data products#
Use the detailed technical documentation about all available endpoints and methods, that cover functionality for built-in access control as well as data products:
A full OpenAPI specification for the REST API is available on the server at the
Starburst Warp Speed#
A separate REST API for Starburst Warp Speed is available. It uses the same authentication and authorization, but includes a separate set of endpoints. These endpoints use a separate context for each catalog.