ProductsDownload Community Edition

SQL Processors

get

Returns the logs produced by a running Kubernetes Pod

Path parameters
clusterstring · min: 1Required

Pod's cluster

namespacestring · min: 1Required

Pod's namespace

podstring · min: 1Required

Pod's name

Responses
200Success
text/plain
Responsestring
get
GET /api/v1/environments/{name}/proxy/api/v1/k8s/logs/{cluster}/{namespace}/{pod}/download HTTP/1.1
Host: 
Accept: */*

text
get

Retrieves the SQL processor details

Path parameters
idstring · min: 1Required

SQL processor unique identifier

Responses
200Success
application/json
get
GET /api/v1/environments/{name}/proxy/api/v2/streams/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "application": {
    "name": "text",
    "processorId": "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-05-01T15:20:16.666Z",
    "processorType": "PreDaD"
  },
  "deployment": {
    "details": {
      "replicas": 1,
      "cluster": "text",
      "namespace": "text",
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "otherSettings": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "status": {
      "level": "NOT_RUNNING",
      "startedAt": "2025-05-01T15:20:16.666Z",
      "stoppedAt": "2025-05-01T15:20:16.666Z",
      "replicas": [
        {
          "id": "text",
          "status": "STOPPED",
          "msg": "text"
        }
      ]
    }
  }
}
delete

Removes an existing SQL processor

Path parameters
idstring · min: 1Required

SQL processor unique identifier

Responses
200Success
application/json
Responsestring · min: 1
delete
DELETE /api/v1/environments/{name}/proxy/api/v1/streams/{id} HTTP/1.1
Host: 
Accept: */*

text
post

Creates a new SQL processor

Body
namestring · min: 1Required
processorIdstring · min: 1Optional
sqlstring · min: 1Required
descriptionstring · min: 1Optional
deploymentone ofRequired
or
objectOptional
tagsstring[]Optional
Responses
201Success
application/json
post
POST /api/v1/environments/{name}/proxy/api/v2/streams HTTP/1.1
Host: 
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

Responses
200Success
application/json
get
GET /api/v1/environments/{name}/proxy/api/v2/streams HTTP/1.1
Host: 
Accept: */*

{
  "processors": [
    {
      "id": "text",
      "application": {
        "name": "text",
        "processorId": "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-05-01T15:20:16.666Z",
        "processorType": "PreDaD"
      },
      "deployment": {
        "details": {
          "replicas": 1,
          "cluster": "text",
          "namespace": "text",
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "otherSettings": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "status": {
          "level": "NOT_RUNNING",
          "startedAt": "2025-05-01T15:20:16.666Z",
          "stoppedAt": "2025-05-01T15:20:16.666Z",
          "replicas": [
            {
              "id": "text",
              "status": "STOPPED",
              "msg": "text"
            }
          ]
        }
      }
    }
  ]
}
get

Returns the logs produced by a running Kubernetes Pod

Path parameters
clusterstring · min: 1Required

Pod's cluster

namespacestring · min: 1Required

Pod's namespace

podstring · min: 1Required

Pod's name

Responses
200Success
text/plain
Responsestring
get
GET /api/v1/environments/{name}/proxy/api/v1/k8s/logs/{cluster}/{namespace}/{pod}/download HTTP/1.1
Host: 
Accept: */*

text
get

Returns deployments information

Responses
200Success
application/json
get
GET /api/v1/environments/{name}/proxy/api/v1/deployment/targets HTTP/1.1
Host: 
Accept: */*

{
  "kubernetes": [
    {
      "cluster": "text",
      "namespaces": [
        "text"
      ],
      "version": "text"
    }
  ],
  "connect": [
    {
      "cluster": "text",
      "version": "text"
    }
  ]
}
PreviousApplicationsNextKafka Connectors

Last updated

Was this helpful?