SQL Streaming

List SQL Processors

get

Returns a list of all registered SQL processors with their current states, configurations, and metadata. Results are filtered based on the caller's permissions.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v2/streams

GET /api/v1/environments/{environment}/proxy/api/v2/streams HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "processors": [
    {
      "id": "text",
      "application": {
        "name": "text",
        "processorId": "text",
        "lrn": "text",
        "sql": "text",
        "inputTopics": [
          {
            "name": "text",
            "keyFormat": "TWAVRO",
            "valueFormat": "TWAVRO"
          }
        ],
        "outputTopics": [
          {
            "name": "text",
            "keyFormat": "TWAVRO",
            "valueFormat": "TWAVRO"
          }
        ],
        "otherSettings": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "metadata": {
        "description": "text",
        "tags": [
          "text"
        ],
        "createdBy": "text",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "processorType": "PreDaD"
      },
      "deployment": {
        "details": {
          "replicas": 1,
          "otherSettings": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "cluster": "text",
          "namespace": "text"
        },
        "status": {
          "level": "NOT_RUNNING",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "stoppedAt": "2026-01-01T00:00:00.000Z",
          "replicas": [
            {
              "id": "text",
              "status": "STOPPED",
              "msg": "text"
            }
          ]
        }
      },
      "coverage": "full"
    }
  ]
}

Create SQL Processor

post

Registers and creates a new SQL processor with the provided configuration. The processor executes streaming SQL queries against Kafka topics. Returns the processor ID and initial state upon successful creation.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

namestring · min: 1Required

processorIdstring · min: 1Optional

sqlstring · min: 1Required

descriptionstring · min: 1Optional

deploymentone ofRequired

or

object · agent_LensesDeploymentOptional

tagsstring[]Optional

Responses

201Success

application/json

idstring · min: 1Required

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v2/streams

POST /api/v1/environments/{environment}/proxy/api/v2/streams HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "name": "text",
  "processorId": "text",
  "sql": "text",
  "description": "text",
  "deployment": {
    "details": {
      "runners": 1,
      "cluster": "text",
      "namespace": "text",
      "requestedCpu": 1,
      "limitCpu": 1,
      "requestedMemory": 1,
      "limitMemory": 1
    }
  },
  "tags": [
    "text"
  ]
}

{
  "id": "text"
}

List SQL Processors (Legacy)

get

Legacy endpoint for listing SQL processors. Use the V2 endpoint for new integrations which provides enhanced response format.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/streams

GET /api/v1/environments/{environment}/proxy/api/v1/streams HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "targets": [
    {
      "cluster": "text",
      "version": "text",
      "namespaces": [
        "text"
      ]
    }
  ],
  "streams": [
    {
      "user": "text",
      "name": "text",
      "id": "text",
      "lrn": "text",
      "processorId": "text",
      "sql": "text",
      "clusterName": "text",
      "startTs": 1,
      "namespace": "text",
      "pipeline": "text",
      "runners": 1,
      "inputTopics": [
        "text"
      ],
      "outputTopics": [
        "text"
      ],
      "state": {
        "deploymentStatus": "FAILED",
        "deploymentError": "text",
        "runnerStatus": {
          "ANY_ADDITIONAL_PROPERTY": {
            "id": "text",
            "worker": "text",
            "status": "FAILED",
            "errorMsg": "text"
          }
        }
      },
      "upTime": 1,
      "stopTs": 1,
      "lastAction": {
        "action": "Scaled",
        "msg": "text"
      },
      "processorType": "PreDaD",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "coverage": "full"
    }
  ]
}

Create SQL Processor (Legacy)

post

Legacy endpoint for creating SQL processors. Use the V2 endpoint for new integrations. Returns the processor ID as a string.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

namestringRequired

appIdstringOptional

sqlstringRequired

runnerCountintegerRequired

clusterstringOptional

namespacestringOptional

userstringOptional

pipelinestringOptional

Responses

201Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v1/streams

POST /api/v1/environments/{environment}/proxy/api/v1/streams HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "name": "text",
  "appId": "text",
  "sql": "text",
  "runnerCount": 1,
  "cluster": "text",
  "namespace": "text",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "user": "text",
  "pipeline": "text"
}

text

Get SQL Processor (Legacy)

get

Legacy endpoint for retrieving SQL processor details. Use the V2 endpoint for new integrations which provides enhanced response format.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

200Success

application/json

userstringRequired

namestringRequired

idstringRequired

lrnstringRequired

processorIdstringRequired

sqlstringOptional

clusterNamestringRequired

startTsinteger · int64Optional

namespacestringRequired

pipelinestringOptional

runnersintegerRequired

inputTopicsstring[]Optional

outputTopicsstring[]Optional

upTimeinteger · int64Optional

stopTsinteger · int64Optional

processorTypestring · enumRequiredPossible values:

coveragestring · enumRequiredPossible values:

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/streams/{id}

GET /api/v1/environments/{environment}/proxy/api/v1/streams/{id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user": "text",
  "name": "text",
  "id": "text",
  "lrn": "text",
  "processorId": "text",
  "sql": "text",
  "clusterName": "text",
  "startTs": 1,
  "namespace": "text",
  "pipeline": "text",
  "runners": 1,
  "inputTopics": [
    "text"
  ],
  "outputTopics": [
    "text"
  ],
  "state": {
    "deploymentStatus": "FAILED",
    "deploymentError": "text",
    "runnerStatus": {
      "ANY_ADDITIONAL_PROPERTY": {
        "id": "text",
        "worker": "text",
        "status": "FAILED",
        "errorMsg": "text"
      }
    }
  },
  "upTime": 1,
  "stopTs": 1,
  "lastAction": {
    "action": "Scaled",
    "msg": "text"
  },
  "processorType": "PreDaD",
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "coverage": "full"
}

Delete SQL Processor

delete

Permanently removes a SQL processor and its associated resources. The processor must be in a stopped state before deletion. Returns the deleted processor ID.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

200Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete/api/v1/environments/{environment}/proxy/api/v1/streams/{id}

DELETE /api/v1/environments/{environment}/proxy/api/v1/streams/{id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Get SQL Processor

get

Retrieves detailed information about a specific SQL processor including its configuration, current state, SQL query, input/output topics, and runtime metrics.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

200Success

application/json

idstring · min: 1Required

coveragestring · enumRequiredPossible values:

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v2/streams/{id}

GET /api/v1/environments/{environment}/proxy/api/v2/streams/{id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "application": {
    "name": "text",
    "processorId": "text",
    "lrn": "text",
    "sql": "text",
    "inputTopics": [
      {
        "name": "text",
        "keyFormat": "TWAVRO",
        "valueFormat": "TWAVRO"
      }
    ],
    "outputTopics": [
      {
        "name": "text",
        "keyFormat": "TWAVRO",
        "valueFormat": "TWAVRO"
      }
    ],
    "otherSettings": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "metadata": {
    "description": "text",
    "tags": [
      "text"
    ],
    "createdBy": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "processorType": "PreDaD"
  },
  "deployment": {
    "details": {
      "replicas": 1,
      "otherSettings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "cluster": "text",
      "namespace": "text"
    },
    "status": {
      "level": "NOT_RUNNING",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "stoppedAt": "2026-01-01T00:00:00.000Z",
      "replicas": [
        {
          "id": "text",
          "status": "STOPPED",
          "msg": "text"
        }
      ]
    }
  },
  "coverage": "full"
}

Get SQL Processor Graph

get

Returns the DAG (Directed Acyclic Graph) representation of the SQL processor's topology, showing the flow of data through operators, sources, and sinks.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

200Success

application/json

sourcesstring[]Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/graph

GET /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/graph HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "sources": [
    "text"
  ],
  "nodes": [
    {
      "key": "text",
      "description": "text",
      "type": "STREAM",
      "nodeType": "PreDaDProcessor",
      "keyType": "TWAVRO",
      "valueType": "TWAVRO",
      "children": [
        "text"
      ]
    }
  ]
}

Start SQL Processor

put

Initiates execution of a SQL processor that is in a stopped or created state. The processor will begin consuming from input topics and producing to output topics. Returns 202 Accepted as the operation is asynchronous.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

202Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/start

PUT /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/start HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Resume SQL Processor

put

Resumes a previously stopped SQL processor from its last committed offset. Unlike start, resume continues processing from where it left off rather than resetting offsets. Returns 202 Accepted as the operation is asynchronous.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

202Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/resume

PUT /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/resume HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Stop SQL Processor

put

Gracefully stops a running SQL processor. The processor will commit its current offsets before stopping, allowing it to be resumed later. Returns 202 Accepted as the operation is asynchronous.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Responses

202Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/stop

PUT /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/stop HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Scale SQL Processor

put

Adjusts the number of parallel runner instances for a SQL processor to increase or decrease throughput. Only available for Kubernetes deployments. The scale value must be a positive integer.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

scalestringRequired

The new SQL processor runner count. It has to be an integer bigger than zero.

Responses

202Success

application/json

string · min: 1Optional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/scale/{scale}

PUT /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/scale/{scale} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Change SQL Processor Docker Image

put

Updates the Docker image used by a SQL processor's runners. This allows upgrading or changing the processor runtime without recreating the processor. The processor should be stopped before changing the image.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · min: 1Required

SQL processor unique identifier

Body

imagestring · min: 1Required

Responses

202Success

application/json

idstring · min: 1Required

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/image

PUT /api/v1/environments/{environment}/proxy/api/v1/streams/{id}/image HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "image": "text"
}

{
  "id": "text"
}

Get Streaming SQL Intellisense

post

Provides code completion, syntax validation, and schema suggestions for streaming SQL queries against Kafka topics. Returns completions, errors, and metadata based on the cursor position in the query.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

sqlstringRequired

caretintegerOptional

Responses

200Success

application/json

inputstringRequired

caretintegerRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v1/intellisense/streams/kafka

POST /api/v1/environments/{environment}/proxy/api/v1/intellisense/streams/kafka HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "sql": "text",
  "caret": 1
}

{
  "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"
    }
  ],
  "statementsPositions": [
    {
      "index": 1,
      "start": 1,
      "end": 1
    }
  ]
}