IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks.
IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks.
### Enable RESTful Services
RESTful services are disabled by default.
* Developer
Find the `IoTDBrestServiceConfig` class under `org.apache.iotdb.db.conf.rest` in the sever module, and modify `enableRestService=true`.
* User
Find the `conf/iotdb.properties` file under the IoTDB installation directory and set `enable_rest_service` to `true` to enable the module.
```properties
enable_rest_service=true
```
### Authentication
### Authentication
RESTful services use the basic authentication. Each URL request needs to carry `'Authorization': 'Basic ' + base64.encode(username + ':' + password)`.
RESTful services use the basic authentication. Each URL request needs to carry `'Authorization': 'Basic ' + base64.encode(username + ':' + password)`.
### Interface
### Interface
#### ping
#### ping
...
@@ -96,6 +109,8 @@ Response parameters:
...
@@ -96,6 +109,8 @@ Response parameters:
**Examples:**
**Examples:**
Tip: Statements like `select * from root.xx.**` are not recommended because those statements may cause OOM.