ProductsDownload Community Edition

SQL Streaming

get

Retrieves all SQL processor details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
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": "2025-11-15T14:32:43.479Z",
        "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": "2025-11-15T14:32:43.479Z",
          "stoppedAt": "2025-11-15T14:32:43.479Z",
          "replicas": [
            {
              "id": "text",
              "status": "STOPPED",
              "msg": "text"
            }
          ]
        }
      },
      "coverage": "full"
    }
  ]
}
post

Creates a new SQL processor

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
objectOptional
tagsstring[]Optional
Responses
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"
}
get

Retrieves all SQL processor details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
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"
    }
  ]
}
post

Creates a new SQL processor

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
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

Retrieves the SQL processor details

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
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

Removes an existing SQL processor

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
Responsestring · min: 1
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

Retrieves the SQL processor details

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
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": "2025-11-15T14:32:43.479Z",
    "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": "2025-11-15T14:32:43.479Z",
      "stoppedAt": "2025-11-15T14:32:43.479Z",
      "replicas": [
        {
          "id": "text",
          "status": "STOPPED",
          "msg": "text"
        }
      ]
    }
  },
  "coverage": "full"
}
get

Retrieves the SQL processor details

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
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"
      ]
    }
  ]
}
put

Runs a SQL processor

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · min: 1Required

SQL processor unique identifier

Responses
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
put

Runs a SQL processor

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · min: 1Required

SQL processor unique identifier

Responses
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
put

Stops a running SQL processor

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · min: 1Required

SQL processor unique identifier

Responses
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
put

Scales a SQL processor

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
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
put

Changes the Docker image of a SQL processor

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
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"
}
post

Returns the query intellisense information

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
sqlstringRequired
caretintegerOptional
Responses
200Success
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
    }
  ]
}
PreviousApplications ManagementNextSQL Snapshot

Last updated

Was this helpful?