ProductsDownload Community Edition

agentProxy

get

Retrieves a list of datasets

Authorizations
Path parameters
environmentstringRequired
Query parameters
pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1
pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25
querystringOptional

A search keyword to match dataset, fields and description against.

Example: name
connectionsstring[]Optional

A list of connection names to filter by. All connections will be included when no value is supplied.

tagsstring[]Optional

A list of tag names to filter by. All tags will be included when no value is supplied.

sortBystring · enumOptional

The field to sort results by

Possible values:
sortingOrderstring · enumOptional

Sorting order. Defaults to ascending

Possible values:
includeSystemEntitiesbooleanOptional

A flag to include in the search also system entities (e.g. Kafka's __consumer_offsets topic).

includeMetadatabooleanOptional

Whether to search only by table name, or also to include field names/documentation (defaults to true)

formatstring[]Optional

Schema format. Relevant only when sourceType is SchemaRegistrySubject

hasRecordsbooleanOptional

Filter based on whether the dataset has records

compactedbooleanOptional

Filter based on compacted. Relevant only when sourceType is Kafka

Responses
200

A response wrapping a paginated list of datasets and the set of relative source types

application/json
get
/v1/environments/{environment}/proxy/api/v1/datasets
GET /v1/environments/{environment}/proxy/api/v1/datasets?pageSize=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "datasets": {
    "values": [
      {
        "name": "text",
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 1,
            "endIndex": 1,
            "arrayIndex": 1
          }
        ],
        "records": 1,
        "recordsPerSecond": 1,
        "keyType": "text",
        "valueType": "text",
        "connectionName": "text",
        "replication": 1,
        "consumers": 1,
        "partitions": 1,
        "fields": {
          "key": [
            {
              "name": "text",
              "type": "text",
              "typeDetails": {
                "lensesDataType": "text"
              },
              "description": "text",
              "ancestors": [
                "text"
              ],
              "highlights": [
                {
                  "fieldName": "text",
                  "startIndex": 1,
                  "endIndex": 1,
                  "arrayIndex": 1
                }
              ],
              "isNullable": true,
              "default": "text"
            }
          ],
          "value": [
            {
              "name": "text",
              "type": "text",
              "typeDetails": {
                "lensesDataType": "text"
              },
              "description": "text",
              "ancestors": [
                "text"
              ],
              "highlights": [
                {
                  "fieldName": "text",
                  "startIndex": 1,
                  "endIndex": 1,
                  "arrayIndex": 1
                }
              ],
              "isNullable": true,
              "default": "text"
            }
          ]
        },
        "isSystemEntity": true,
        "isMarkedForDeletion": true,
        "isCompacted": true,
        "sizeBytes": 1,
        "policies": [
          {
            "policyId": "text",
            "policyName": "text",
            "policyCategory": "text",
            "obfuscation": "text",
            "matchingKeyFields": [
              {
                "name": "text",
                "parents": [
                  "text"
                ]
              }
            ],
            "matchingValueFields": [
              {
                "name": "text",
                "parents": [
                  "text"
                ]
              }
            ]
          }
        ],
        "permissions": [
          "text"
        ],
        "description": "text",
        "tags": [
          {
            "name": "text",
            "count": 1
          }
        ],
        "retentionMs": 1,
        "retentionBytes": 1,
        "backupRestoreState": {},
        "sourceType": "text",
        "lrn": "text"
      }
    ],
    "pagesAmount": 1,
    "totalCount": 1
  },
  "sourceTypes": [
    "Kafka"
  ]
}
put

Updates the offset for a topic-partition for the given group

Authorizations
Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitioninteger · int64Required

The topic partition number

Body
offsetinteger · int64Required
typestringRequired
Responses
200Success
No content
put
/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition}
PUT /v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "offset": 1,
  "type": "text"
}
No content
put

Update the offset for a consumer group topic-partition tuples

Authorizations
Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

Body
one ofOptional
or
or
Responses
200Success
No content
put
/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets
PUT /v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "type": null,
  "topics": [
    "text"
  ]
}
No content
delete

Delete the offset for a topic-partition for the given group

Authorizations
Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitionintegerRequired

The topic partition number

Responses
200Success
No content
delete
/v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets
DELETE /v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
delete

Returns the consumer groups which are using the given topic

Authorizations
Path parameters
environmentstringRequired
consumerGroupNamestringRequired

The consumer group name

Responses
200Success
No content
delete
/v1/environments/{environment}/proxy/api/consumers/{consumerGroupName}
DELETE /v1/environments/{environment}/proxy/api/consumers/{consumerGroupName} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
get

Get a single dataset by connection/name. While information mastered externally might be a few second out of sync with their respective sources (e.g. JMX metadata, Elasticsearch index status, etc), information mastered in Lenses's db is guaranteed to be up to date (e.g. tags, descriptions).

Authorizations
Path parameters
environmentstringRequired
connectionstringRequiredExample: kafka
datasetstringRequiredExample: customer-positions
Responses
200Success
application/json
Responseone of
get
/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{dataset}
GET /v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{dataset} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "highlights": [
    {
      "fieldName": "text",
      "startIndex": 1,
      "endIndex": 1,
      "arrayIndex": 1
    }
  ],
  "records": 1,
  "recordsPerSecond": 1,
  "keyType": "text",
  "valueType": "text",
  "connectionName": "text",
  "replication": 1,
  "consumers": 1,
  "partitions": 1,
  "fields": {
    "key": [
      {
        "name": "text",
        "type": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 1,
            "endIndex": 1,
            "arrayIndex": 1
          }
        ],
        "isNullable": true,
        "default": "text"
      }
    ],
    "value": [
      {
        "name": "text",
        "type": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 1,
            "endIndex": 1,
            "arrayIndex": 1
          }
        ],
        "isNullable": true,
        "default": "text"
      }
    ]
  },
  "isSystemEntity": true,
  "isMarkedForDeletion": true,
  "isCompacted": true,
  "sizeBytes": 1,
  "policies": [
    {
      "policyId": "text",
      "policyName": "text",
      "policyCategory": "text",
      "obfuscation": "text",
      "matchingKeyFields": [
        {
          "name": "text",
          "parents": [
            "text"
          ]
        }
      ],
      "matchingValueFields": [
        {
          "name": "text",
          "parents": [
            "text"
          ]
        }
      ]
    }
  ],
  "permissions": [
    "text"
  ],
  "description": "text",
  "tags": [
    {
      "name": "text",
      "count": 1
    }
  ],
  "retentionMs": 1,
  "retentionBytes": 1,
  "backupRestoreState": {},
  "sourceType": "text",
  "lrn": "text"
}
get

Retrieve information topic defaults

Authorizations
Path parameters
environmentstringRequired

Name of the environment

Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/configs/default/topics
GET /v1/environments/{environment}/proxy/api/configs/default/topics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "key": "text",
    "default": {
      "default": "text",
      "serverDefaultProperties": "text",
      "description": "text"
    }
  }
]
put
Authorizations
Path parameters
environmentstringRequired

Name of the environment

topicstringRequired

The topic name

Body
Responses
200Success
application/json
Responsestring
put
/v1/environments/{environment}/proxy/api/configs/topics/{topic}
PUT /v1/environments/{environment}/proxy/api/configs/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "configs": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}
text
get

Retrieve information about a given topic

Authorizations
Path parameters
environmentstringRequired

Name of the environment

topicstringRequired

Name of the topic

Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/topics/{topic}
GET /v1/environments/{environment}/proxy/api/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "topicName": "text",
  "partitions": 1,
  "replication": 1,
  "isControlTopic": true,
  "isCompacted": true,
  "keyType": "text",
  "valueType": "text",
  "totalMessages": 1,
  "config": [
    {
      "name": "text",
      "value": "text",
      "isDefault": true,
      "defaultValue": "text",
      "documentation": "text",
      "originalValue": "text"
    }
  ],
  "consumers": [
    {
      "id": "text",
      "coordinator": {
        "id": 1,
        "host": "text",
        "port": 1,
        "rack": "text"
      },
      "active": true,
      "state": "Unknown",
      "consumers": [
        "text"
      ],
      "consumersCount": 1,
      "topicPartitionsCount": 1,
      "minLag": 1,
      "maxLag": 1,
      "application": {
        "id": "text",
        "name": "text",
        "type": "AkkaStreams"
      }
    }
  ],
  "messagesPerPartition": [
    {
      "partition": 1,
      "messages": 1,
      "begin": 1,
      "end": 1
    }
  ],
  "messagesPerSecond": 1,
  "isMarkedForDeletion": true,
  "timestamp": 1,
  "keySchema": "text",
  "keySchemaVersion": 1,
  "keySchemaInlined": "text",
  "valueSchema": "text",
  "valueSchemaVersion": 1,
  "valueSchemaInlined": "text",
  "applications": [
    {
      "id": "text",
      "name": "text",
      "type": "AkkaStreams"
    }
  ],
  "description": "text",
  "tags": [
    {
      "name": "text",
      "count": 1
    }
  ],
  "permissions": [
    "text"
  ],
  "backups": [
    {
      "id": 1,
      "createdAt": "2025-10-24T16:07:49.113Z",
      "topic": "text",
      "connectCluster": "text",
      "connectorName": "text",
      "connectorVersion": "text",
      "s3Location": "text",
      "reference": "text"
    }
  ],
  "restores": [
    {
      "id": 1,
      "createdAt": "2025-10-24T16:07:49.113Z",
      "topic": "text",
      "connectCluster": "text",
      "connectorName": "text",
      "connectorVersion": "text",
      "s3Location": "text",
      "reference": "text"
    }
  ]
}
delete
Authorizations
Path parameters
environmentstringRequired

Name of the environment

topicstringRequired

Name of the topic

Responses
200Success
application/json
Responsestring
delete
/v1/environments/{environment}/proxy/api/topics/{topic}
DELETE /v1/environments/{environment}/proxy/api/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text
delete
Authorizations
Path parameters
environmentstringRequired

Name of the environment

topicstringRequired

Name of the topic

partitionintegerRequired

Partition where you delete messages from

offsetintegerRequired

Messages will be deleted up to this offset

Responses
200Success
application/json
Responsestring
delete
/v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset}
DELETE /v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text
get

Retrieve information about a given topic

Authorizations
Path parameters
environmentstringRequired
topicstringRequired

Name of the topic

Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/v2/kafka/topics/{topic}
GET /v1/environments/{environment}/proxy/api/v2/kafka/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "topicName": "text",
  "lrn": "text",
  "partitions": 1,
  "replication": 1,
  "isControlTopic": true,
  "keyType": "text",
  "valueType": "text",
  "totalMessages": 1,
  "configs": 1,
  "consumers": 1,
  "messagesPerSecond": 1,
  "isMarkedForDeletion": true,
  "isCompacted": true,
  "description": "text",
  "size": 1,
  "tags": [
    {
      "name": "text",
      "count": 1
    }
  ]
}
get
Authorizations
Path parameters
environmentstringRequired

Environment name

topicstringRequired

Kafka topic name

Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/metadata/topics/{topic}
GET /v1/environments/{environment}/proxy/api/metadata/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "topicName": "text",
  "keyType": "text",
  "valueType": "text",
  "keySchema": "text",
  "keySchemaVersion": 1,
  "keySchemaInlined": "text",
  "valueSchema": "text",
  "valueSchemaVersion": 1,
  "valueSchemaInlined": "text",
  "description": "text",
  "tags": [
    "text"
  ],
  "additionalInfo": null
}
delete
Authorizations
Path parameters
environmentstringRequired

Environment name

topicstringRequired

Kafka topic name

Responses
200Success
No content
delete
/v1/environments/{environment}/proxy/api/metadata/topics/{topic}
DELETE /v1/environments/{environment}/proxy/api/metadata/topics/{topic} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
post
Authorizations
Path parameters
environmentstringRequired

Name of the environment

Body
topicNamestringRequired
keyTypestringRequired
valueTypestringRequired
keySchemastringOptional
keySchemaVersionintegerOptional
keySchemaInlinedstringOptional
valueSchemastringOptional
valueSchemaVersionintegerOptional
valueSchemaInlinedstringOptional
descriptionstringOptional
tagsstring[]Optional
additionalInfoanyOptional
Responses
200Success
No content
post
/v1/environments/{environment}/proxy/api/v1/metadata/topics
POST /v1/environments/{environment}/proxy/api/v1/metadata/topics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "topicName": "text",
  "keyType": "text",
  "valueType": "text",
  "keySchema": "text",
  "keySchemaVersion": 1,
  "keySchemaInlined": "text",
  "valueSchema": "text",
  "valueSchemaVersion": 1,
  "valueSchemaInlined": "text",
  "description": "text",
  "tags": [
    "text"
  ],
  "additionalInfo": null
}
No content
get
Authorizations
Path parameters
environmentstringRequired

Name of the environment

Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/metadata/topics/decoders
GET /v1/environments/{environment}/proxy/api/metadata/topics/decoders HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "keys": [
    "text"
  ],
  "values": [
    "text"
  ]
}
post

Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.

Authorizations
Path parameters
environmentstringRequired
topicstringRequired

The topic name

Body
clusterstringRequired
Responses
201Success
application/json
post
/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/backup
POST /v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/backup HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "cluster": "text",
  "s3": {
    "bucket": "text",
    "prefix": "text"
  },
  "flush": {
    "count": 1,
    "size": 1,
    "interval": 1
  }
}
{
  "id": 1,
  "connector": "text",
  "cluster": "text"
}
post

Restores data from S3 into the target topic.

Authorizations
Path parameters
environmentstringRequired
topicstringRequired

The topic name

Body
clusterstringRequired
storageFormatstring · enumRequiredPossible values:
Responses
201Success
application/json
post
/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/restore
POST /v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/restore HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "cluster": "text",
  "s3": {
    "bucket": "text",
    "prefix": "text"
  },
  "storageFormat": "avro"
}
{
  "id": 1,
  "connector": "text",
  "cluster": "text"
}
put
Authorizations
Path parameters
environmentstringRequired
topicNamestringRequired
Body
partitionsintegerRequired
Responses
200Success
application/json
put
/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions
PUT /v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "partitions": 1
}
{
  "partitions": 1
}
get

Retrieves a list of dataset tags

Authorizations
Path parameters
environmentstringRequired
Query parameters
querystringOptional

Get tags sorted by dataset count

Example: user
Responses
200

A response wrapping a paginated list of datasets and the set of relative source types

application/json
get
/v1/environments/{environment}/proxy/api/v1/datasets/tags
GET /v1/environments/{environment}/proxy/api/v1/datasets/tags HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tags": [
    {
      "name": "text",
      "count": 1
    }
  ]
}
get

Returns the list of available connections

Authorizations
Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/v1/connection/connections
GET /v1/environments/{environment}/proxy/api/v1/connection/connections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "the-connection",
    "templateName": "Kafka",
    "templateVersion": 1,
    "tags": [
      "text"
    ],
    "deletable": true
  }
]
post

Returns the intellisense result for a given query

Authorizations
Path parameters
environmentstringRequired
Body
sqlstringRequired
caretintegerOptional
connectorIdstringOptional
Responses
200

Happy response

application/json
post
/v1/environments/{environment}/proxy/api/v1/sql/presentation
POST /v1/environments/{environment}/proxy/api/v1/sql/presentation HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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
    }
  ]
}
post

Publish data to a Kafka topic.

Authorizations
Path parameters
environmentstringRequired
topicstringRequired

The topic name

Query parameters
ktstringOptional

Key type

vtstringOptional

Value type

Body
anyOptional
Responses
201Success
application/json
post
/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/data
POST /v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/data HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/jsonn
Accept: */*

{
  "success": true,
  "schemaChanged": true
}
get

Returns deployments information

Authorizations
Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/v1/environments/{environment}/proxy/api/v1/deployment/targets
GET /v1/environments/{environment}/proxy/api/v1/deployment/targets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Returns provisioning information

Authorizations
Path parameters
environmentstringRequired
Responses
200Success
application/yaml
Responsestring
get
/v1/environments/{environment}/proxy/api/v1/state/connections
GET /v1/environments/{environment}/proxy/api/v1/state/connections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text
PreviousenvironmentsNextgroups

Last updated

Was this helpful?