SQL Query Management
Stops a running query
The SQL Snapshot query identifier
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
DELETE /api/v1/environments/{name}/proxy/api/v1/sql/execution/{queryId} HTTP/1.1
Host:
Accept: */*
No content
Returns all running queries
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/v1/sql/queries HTTP/1.1
Host:
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"started": "2025-08-31T22:03:59.572Z",
"finished": "2025-08-31T22:03:59.572Z",
"sql": "text",
"username": "text",
"status": "Completed",
"message": "text"
}
]
Returns the topic/table paging details. For a Kafka topic this means returning the start/end offset
The target table
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{name}/proxy/api/v1/sql/paging?table=text HTTP/1.1
Host:
Accept: */*
[
{
"tableName": {
"value": "text"
},
"type": {
"value": "text"
},
"label": "text",
"partitions": [
{
"id": {
"value": 1
},
"label": "text",
"start": 1,
"end": 1
}
]
}
]
Returns the intellisense result for a given query
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{name}/proxy/api/v1/sql/presentation HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"sql": "text",
"caret": 1,
"connectorId": "text"
}
{
"input": "text",
"caret": 1,
"lints": [
{
"start": 1,
"end": 1,
"text": "text",
"type": "Warning"
}
],
"suggestions": [
{
"display": "text",
"text": "text",
"start": 1,
"end": 1,
"type": "text",
"description": "text",
"highlightStart": 1,
"highlightEnd": 1
}
],
"highlights": [
{
"start": 1,
"end": 1,
"text": "text",
"type": "Keyword"
}
],
"tables": [
{
"tableName": {
"value": "text"
},
"fields": [
{
"value": "text"
}
]
}
],
"statementsPositions": [
{
"index": 1,
"start": 1,
"end": 1
}
]
}
Last updated
Was this helpful?