REST API overview

This article describes how to use the REST API.

This article describes how to interact with your cluster over HTTPS.

Supported actions

The available actions for an endpoint depend on whether it’s an engine endpoint or a data management endpoint. In the Azure portal cluster overview, the engine endpoint is identified as the Cluster URI and the data management endpoint as the Data ingestion URI.

ActionHTTP verbURI templateEngineData ManagementAuthentication
QueryGET or POST/v1/rest/queryYesNoYes
QueryGET or POST/v2/rest/queryYesNoYes
ManagementPOST/v1/rest/mgmtYesYesYes
StreamIngestPOST/v1/rest/ingestYesNoYes
UIGET/YesNoNo
UIGET/{dbname}YesNoNo

Where Action represents a group of related activities

  • The Query action sends a query to the service and gets back the results of the query.
  • The Management action sends a management command to the service and gets back the results of the management command.
  • The StreamIngest action ingests data to a table.
  • The UI action can be used to start up a desktop client or web client. The action is done through an HTTP Redirect response, to interact with the service.

Related content