Skip to main content
DELETE
/
databases
/
{databaseName}
Delete all tables in given database name
curl --request DELETE \
  --url https://dev.startree.ai/databases/{databaseName} \
  --header 'Authorization: <api-key>'
import requests

url = "https://dev.startree.ai/databases/{databaseName}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://dev.startree.ai/databases/{databaseName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.startree.ai/databases/{databaseName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://dev.startree.ai/databases/{databaseName}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://dev.startree.ai/databases/{databaseName}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.startree.ai/databases/{databaseName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "deletedTables": [
    "<string>"
  ],
  "failedTables": [
    {
      "tableName": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "dryRun": true
}

Authorizations

Authorization
string
header
required

The format of the key is "Basic <token>" or "Bearer <token>"

Path Parameters

databaseName
string
required

Database name

Query Parameters

dryRun
boolean
default:true
required

Run in dryRun mode initially to know the list of tables that will be deleted in actual run. No tables will be deleted when dryRun=true

Response

200 - application/json

successful operation

deletedTables
string[]
read-only
failedTables
object[]
read-only
dryRun
boolean
read-only