Chilkat Online Tools

TCL / Cognite API v1 / Delete databases

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "items": [
#   ],
#   "recursive": false
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateNewArray $json "items"
CkJsonObject_UpdateBool $json "recursive" 0

CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/api/v1/projects/{{project}}/raw/dbs/delete" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [],
    "recursive": false
}'
https://domain.com/api/v1/projects/{{project}}/raw/dbs/delete

Postman Collection Item JSON

{
  "id": "deleteDBs",
  "name": "Delete databases",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "raw",
        "dbs",
        "delete"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "It deletes a database, but fails if the database is not empty and recursive is set to false (default).",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [],\n    \"recursive\": false\n}"
    }
  }
}