Clear an SQL search cursor Added in 6.3.0

POST /_sql/close
Api key auth Basic auth Bearer auth
application/json

Body Required

  • cursor string Required

    Cursor to clear.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
POST /_sql/close 
curl \
 --request POST http://api.example.com/_sql/close \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"cursor":"string"}'
Request examples 
{
  "cursor": "string"
}
Response examples (200) 
{
  "succeeded": true
}