# Enable the Data API SingleStore’s Data API is accessible via a built-in HTTP server. The Data API is enabled by default. When the Data API is enabled, it will be hosted on a port that is different from the SingleStore port. ## Enable the Data API Service **Step 1: Enable the WebSocket Proxy** To enable the WebSocket proxy on the required nodes, you can use SingleStore Toolbox commands on a host where [SingleStore Toolbox](https://docs.singlestore.com/db/v9.1/user-and-cluster-administration/cluster-management-with-tools/singlestore-tools-installation.md) is installed and configured.  Before enabling WebSocket proxy, you need to obtain the `MemSQL ID` of the nodes for which you want to set the `https_proxy_port` or the `http_proxy_port` variable. SingleStore recommends enabling the Data API on every aggregator node in the cluster, so you will likely need the `MemSQL ID` of all aggregator nodes. To perform this action, run the following command. ```shell sdb-admin list-nodes --role Master -q ``` Then use `sdb-admin update config` to set **either** the `https_proxy_port` or the `http_proxy_port` variable to any free port available and specify the `MemSQL ID` obtained for the aggregator nodes in the previous command. **For HTTPS**: ```shell sdb-admin update-config --memsql-id --set-global --key https_proxy_port --value ``` **For HTTP:** ```shell sdb-admin update-config --memsql-id --set-global --key http_proxy_port --value ``` Note that `https_proxy_port` and `http_proxy_port` variables are mutually exclusive and the proxy will fail to start if both are set. The `https_proxy_port` variable requires [SSL to be enabled](https://docs.singlestore.com/db/v9.1/security/encryption/ssl-secure-connections.md). **Step 2: Enable the API Endpoints** To make the API endpoints accessible on the HTTP server, run the following SingleStore Toolbox command. SingleStore recommends enabling the Data API on every aggregator node in the cluster, so you will likely need to specify the ID of each aggregator node. ```shell sdb-admin update-config --memsql-id --set-global --key "http_api" --value "ON" ``` If the server is already running when you update the configuration, run the following command at the SingleStore command-line for the changes to take effect. ```SQL RESTART PROXY; ``` > **❗ Important**: - The variables used for enabling the Data API must be configured on individual nodes. SingleStore recommends enabling the Data API on **every aggregator node** in the cluster. > - SingleStore recommends using `sdb-admin update-config` to set the variables involved in Data API configuration to make sure the variable values persist through server restart. This command, when used with the `--set-global` flag, allows the variable values to take effect immediately (assuming the node is running) in addition to when the node starts. For more information, refer to the [sdb-admin update-config](https://docs.singlestore.com/db/v9.1/reference/singlestore-tools-reference/sdb-admin-commands/update-config.md). > - SingleStore recommends configuring the `https_proxy_port` or the `http_proxy_port` variable to the same value across the cluster. > - The Data API should NOT be enabled on leaf nodes. ## Optimize the Data API Configuration After enabling the API, you can tweak the following connection-related settings for optimum performance of the database.  * Use the `http_api_pool_capacity` to limit the maximum impact of the HTTP server on the database server by limiting the maximum number of connections per user. * Use the `http_api_pool_max_idle` variable to specify the maximum number of connections that can be open in each pool at any point in time. This setting helps reduce latency by holding database connections open. For more information, refer to [Non-Sync Variables List](https://docs.singlestore.com/db/v9.1/reference/configuration-reference/engine-variables/list-of-engine-variables/#non-sync-variables-list.md). ## Test the Data API Call the `GET /ping` API request to verify that the HTTP service is running and connectable. To perform this action using cURL, make a `GET` request to the `/ping` endpoint with no parameters: ```shell curl https://localhost:8080/ping ``` If the Data API service is available and is able to respond to requests, you will receive the following response along with a *200 OK* status code, indicating a successful HTTP response. ```shell ping ``` If an error occurs, you will receive one of the [HTTP response status codes](https://docs.singlestore.com/db/v9.1/reference/data-api/data-api-error-handling.md), along with the error description in the response body. For more information, refer to the [Data API Endpoint Reference](https://docs.singlestore.com/db/v9.1/reference/data-api/data-api-endpoint-reference.md). The `GET /ping` request can only verify whether the HTTP service is running and connectable. To verify that the database can receive queries, use the `/exec` and `/query` endpoints. The following cURL command makes a `POST` API request to the `/query/rows` endpoint. (Replace `root:password` in the HTTP request with your SingleStore `username:password` string.) ```shell curl -H "Content-Type: application/json" --data '{"sql": "select 1+1"}' https://root:password@localhost:8080/api/v2/query/rows ``` If the API call is successful, you should see the following results along with a *200 OK* status code. ```JSON {"results":[{"rows":[{"1+1":2}]}]} ``` If an error occurs, you will receive one of the [HTTP response status codes](https://docs.singlestore.com/db/v9.1/reference/data-api/data-api-error-handling.md), along with the error description in the response body. For more information, refer to the [Data API Endpoint Reference](https://docs.singlestore.com/db/v9.1/reference/data-api/data-api-endpoint-reference.md). If you format the JSON output with a formatting tool, the results appear as follows. (Recommended JSON formatting tools: [jq](https://stedolan.github.io/jq/), [JSONLint](https://jsonlint.com/)) ```JSON { "results": [ { "rows": [ { "1+1": 2 } ] } ] } ``` **Note**: The `GET /ping` request should be used in automated health checks. To verify specific health metrics, use the `/exec` and `/query` endpoints. *** Modified at: July 18, 2024 Source: [/db/v9.1/reference/data-api/enable-the-data-api/](https://docs.singlestore.com/db/v9.1/reference/data-api/enable-the-data-api/) (An index of the documentation is available at /llms.txt)