Environments

Lists all environments

GEThttps://api.example.com/api/v1/environments

Response

Happy response.

Body

items*array of Environment (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

Contains dynamic properties of the Agent, brought in via a connected agent. Only when the agent is connected to HQ, agent info can be updated. An environment that never had a connected agent cannot have a LiveAgentInfo.

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Creates a new environment.

POSThttps://api.example.com/api/v1/environments

Body

name*string (hq-resource-name)

Sets the name of the new environment. It must be a valid HQ resource name: it can only contain lowercase alphanumeric characters or hyphens; hyphens cannot appear at the end or start; the length is 63 characters at most.

display_namestring

Sets the display name of the new environment. If not provided, the value of "name" will be used.

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

agent_key*string

Request

Response

Retrieves a single environment by name.

GEThttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Updates an environment.

PATCHhttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Body

tierTier (enum)

Enumerates Tiers.

developmentstagingproduction

metadataMetadataPatchRequest (object)

Patches metadata. It has the following semantics:

Absent keys are left untouched;
Null values are deleted;
Non-null values are replaced.

Other propertiesnullable string

display_namestring

Updates the display name of the environment.

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Deletes an environment.

DELETEhttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Response

Successful deletion.

Request

Response

Provides Server-Sent Events (SSE) for environment updates. TODO.

GEThttps://api.example.com/api/v1/environments/live/sse

Response

Error object.

Body

typeErrorType (enum)

Enumerates possible error types.

not_foundunauthorisedforbiddeninternal_server_erroragent_not_connectedvalidation_errorinvalid_metadatamissing_parameterinvalid_parameterlicence_limitation_violatedunspecified

title*string

Describes the problem in a human readable fashion.

status*integer

Is a copy of the http status code.

invalid_fieldsarray of InvalidField (object)

Lists for validation errors the fields that failed validation.

name*string

error*FieldErrorType (enum)

Enumerates field validation error types.

reference_not_foundnot_uniqueinvalid_valueother_error

title*string

sso_urlstring

Contains in case of an "unauthorised" type of error, the url of the SSO provider, if any.

request_idstring

Is set to the id of this request. Can be used to correlate backend logs.

Request

Response

Proxies HTTP to a Lenses instance. Note: this is not a regular HTTP API endpoint. The path specified here is a prefix. Everything beneath it gets proxied to the corresponding Lenses instance. Any request body and method (the GET here is only a placeholder) are accepted, as long as the Lenses API accepts it. The connection can even be upgraded to a websocket. The status code and response body are controlled by the Lenses API. This concept does not fit into the OpenAPI world at all; this definition is only here for the sake of documentation to avoid having an undocumented dark matter API.

GEThttps://api.example.com/api/v1/environments/{name}/proxy/

Path parameters

name*string

Response

Error object.

Body

typeErrorType (enum)

Enumerates possible error types.

not_foundunauthorisedforbiddeninternal_server_erroragent_not_connectedvalidation_errorinvalid_metadatamissing_parameterinvalid_parameterlicence_limitation_violatedunspecified

title*string

Describes the problem in a human readable fashion.

status*integer

Is a copy of the http status code.

invalid_fieldsarray of InvalidField (object)

Lists for validation errors the fields that failed validation.

name*string

error*FieldErrorType (enum)

Enumerates field validation error types.

reference_not_foundnot_uniqueinvalid_valueother_error

title*string

sso_urlstring

Contains in case of an "unauthorised" type of error, the url of the SSO provider, if any.

request_idstring

Is set to the id of this request. Can be used to correlate backend logs.

Request

Response

Retrieves a list of datasets

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets

Path parameters

name*string

Query parameters

pageinteger

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

Example: 1

pageSize*integer

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

Example: 25

querystring

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

Example: "name"

connectionsarray of string

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

itemsstring

tagsarray of string

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

itemsstring

sortByDatasetField (enum)

The field to sort results by

namerecordsconnectionNamesourceTypeisSystemEntityrecordsPerSecondkeyTypevalueTypereplicationconsumerspartitionsretentionBytesretentionMssizeBytesreplicasshardversionformatcompatibilitybackupRestoreState

sortingOrderOrder (enum)

Sorting order. Defaults to ascending

ascdesc

includeSystemEntitiesboolean

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

includeMetadataboolean

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

formatarray of string

Schema format. Relevant only when sourceType is SchemaRegistrySubject

itemsstring

hasRecordsboolean

Filter based on whether the dataset has records

compactedboolean

Filter based on compacted. Relevant only when sourceType is Kafka

Response

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

Body

datasets*Page_DatasetMatch (object)

valuesarray of Kafka (object)

name*string

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

recordsinteger (int64)

recordsPerSecond*integer (int64)

keyType*string

valueType*string

connectionName*string

replication*integer

consumers*integer

partitions*integer

fieldsFields (object)

keyarray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

valuearray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

isSystemEntity*boolean

isMarkedForDeletion*boolean

isCompacted*boolean

sizeBytesinteger (int64)

policiesarray of PolicyMatchDetails (object)

policyId*string

policyName*string

policyCategory*string

obfuscation*string

matchingKeyFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

matchingValueFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

permissions*array of string

itemsstring

descriptionstring

tagsarray of DatasetTag (object)

name*string

count*number

retentionMsinteger (int64)

retentionBytesinteger (int64)

backupRestoreStateBackupRestoreState (one of)

sourceType*string

pagesAmount*integer (int64)

totalCount*integer (int64)

sourceTypesarray of SourceType (enum)

itemsSourceType (enum)

KafkaElasticPostgresSchemaRegistrySubject

Request

Response

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

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/{connection}/{dataset}

Path parameters

name*string

connection*string

Example: "kafka"

dataset*string

Example: "customer-positions"

Response

Body

DatasetMatch (one of)

name*string

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

recordsinteger (int64)

recordsPerSecond*integer (int64)

keyType*string

valueType*string

connectionName*string

replication*integer

consumers*integer

partitions*integer

fieldsFields (object)

keyarray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

valuearray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

isSystemEntity*boolean

isMarkedForDeletion*boolean

isCompacted*boolean

sizeBytesinteger (int64)

policiesarray of PolicyMatchDetails (object)

policyId*string

policyName*string

policyCategory*string

obfuscation*string

matchingKeyFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

matchingValueFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

permissions*array of string

itemsstring

descriptionstring

tagsarray of DatasetTag (object)

name*string

count*number

retentionMsinteger (int64)

retentionBytesinteger (int64)

backupRestoreStateBackupRestoreState (one of)

sourceType*string

Request

Response

Retrieves a list of dataset tags

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/tags

Path parameters

name*string

Query parameters

querystring

Get tags sorted by dataset count

Example: "user"

Response

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

Body

tags*array of DatasetTag (object)

name*string

count*number

Request

Response

Returns the intellisense result for a given query

POSThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/sql/presentation

Path parameters

name*string

Body

sql*string

caretinteger

connectorIdstring

Response

Happy response

Body

input*string

caret*integer

lintsarray of Lint (object)

start*integer

end*integer

text*string

type*HintType (enum)

WarningErrorObfuscationInfoSecurity

suggestionsarray of Suggestion (object)

display*string

text*string

start*integer

end*integer

type*string

descriptionstring

highlightStart*integer

highlightEnd*integer

highlightsarray of Highlight1 (object)

start*integer

end*integer

text*string

type*HighlightType (enum)

KeywordStringIntegralFloatBooleanType

tablesarray of TableFields (object)

tableName*TableName (object)

value*string

fieldsarray of FieldName (object)

value*string

statementsPositionsarray of StatementPos (object)

index*integer

start*integer

end*integer

Request

Response

Provides Server-Sent Events (SSE) for environment updates. TODO.

GEThttps://api.example.com/api/v1/environments/live/sse

Response

Error object.

Body

typeErrorType (enum)

Enumerates possible error types.

not_foundunauthorisedforbiddeninternal_server_erroragent_not_connectedvalidation_errorinvalid_metadatamissing_parameterinvalid_parameterlicence_limitation_violatedunspecified

title*string

Describes the problem in a human readable fashion.

status*integer

Is a copy of the http status code.

invalid_fieldsarray of InvalidField (object)

Lists for validation errors the fields that failed validation.

name*string

error*FieldErrorType (enum)

Enumerates field validation error types.

reference_not_foundnot_uniqueinvalid_valueother_error

title*string

sso_urlstring

Contains in case of an "unauthorised" type of error, the url of the SSO provider, if any.

request_idstring

Is set to the id of this request. Can be used to correlate backend logs.

Request

Response

GEThttps://api.example.com/api/v1/environments/{name}/proxy/

Path parameters

name*string

Response

Error object.

Body

typeErrorType (enum)

Enumerates possible error types.

not_foundunauthorisedforbiddeninternal_server_erroragent_not_connectedvalidation_errorinvalid_metadatamissing_parameterinvalid_parameterlicence_limitation_violatedunspecified

title*string

Describes the problem in a human readable fashion.

status*integer

Is a copy of the http status code.

invalid_fieldsarray of InvalidField (object)

Lists for validation errors the fields that failed validation.

name*string

error*FieldErrorType (enum)

Enumerates field validation error types.

reference_not_foundnot_uniqueinvalid_valueother_error

title*string

sso_urlstring

Contains in case of an "unauthorised" type of error, the url of the SSO provider, if any.

request_idstring

Is set to the id of this request. Can be used to correlate backend logs.

Request

Response

Lists all environments

GEThttps://api.example.com/api/v1/environments

Response

Happy response.

Body

items*array of Environment (object)

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Updates an environment.

PATCHhttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Body

tierTier (enum)

Enumerates Tiers.

developmentstagingproduction

metadataMetadataPatchRequest (object)

Patches metadata. It has the following semantics:

Absent keys are left untouched;
Null values are deleted;
Non-null values are replaced.

Other propertiesnullable string

display_namestring

Updates the display name of the environment.

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Deletes an environment.

DELETEhttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Response

Successful deletion.

Request

Response

Creates a new environment.

POSThttps://api.example.com/api/v1/environments

Body

name*string (hq-resource-name)

display_namestring

Sets the display name of the new environment. If not provided, the value of "name" will be used.

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

agent_key*string

Request

Response

Retrieves a list of dataset tags

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/tags

Path parameters

name*string

Query parameters

querystring

Get tags sorted by dataset count

Example: "user"

Response

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

Body

tags*array of DatasetTag (object)

name*string

count*number

Request

Response

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/{connection}/{dataset}

Path parameters

name*string

connection*string

Example: "kafka"

dataset*string

Example: "customer-positions"

Response

Body

DatasetMatch (one of)

name*string

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

recordsinteger (int64)

recordsPerSecond*integer (int64)

keyType*string

valueType*string

connectionName*string

replication*integer

consumers*integer

partitions*integer

fieldsFields (object)

keyarray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

valuearray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

isSystemEntity*boolean

isMarkedForDeletion*boolean

isCompacted*boolean

sizeBytesinteger (int64)

policiesarray of PolicyMatchDetails (object)

policyId*string

policyName*string

policyCategory*string

obfuscation*string

matchingKeyFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

matchingValueFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

permissions*array of string

itemsstring

descriptionstring

tagsarray of DatasetTag (object)

name*string

count*number

retentionMsinteger (int64)

retentionBytesinteger (int64)

backupRestoreStateBackupRestoreState (one of)

sourceType*string

Request

Response

Retrieves a single environment by name.

GEThttps://api.example.com/api/v1/environments/{name}

Path parameters

name*string

Response

Happy response.

Body

name*string

display_name*string

lrn*string

Contains the resource identifier for use in access control policies.

id*string

created_at*string (date-time)

tier*Tier (enum)

Enumerates Tiers.

developmentstagingproduction

status*LiveEnvironmentInfo (object)

agent_connected*boolean

Signals whether an agent is currently connected.

agentLiveAgentInfo (object)

Is a collection of fields related to an agent. Updated only when an agent is connected.

updated_at*string (date-time)

Contains the time instant this object as a whole was updated.

roundtrip_duration*number (double)

Is measured in seconds.

agent*LensesAgentSummary (object)

Bundles licence info as gathered by the agent through Lenses' API.

hostname*string

Is set to the hostname of the machine the agent runs on.

version*string

Contains the version of the agent executable.

metricsAgentMetrics (object)

Bundles several categories of agent metrics.

kafkaAgentKafkaMetrics (object)

Is optionally part of AgentMetrics. Contains Kafka-specific metrics. Unavailable if Zoopeeker is not configured.

version*string

num_brokers*integer

updated_at*string (date-time)

data*AgentDataMetrics (object)

Is a part of AgentMetrics. Contains Data related metrics.

num_topics*integer

num_partitions*integer

num_schemas*integer

num_policies*integer

topic_data_total_bytesinteger (int64)

Is unavailable without Zookeeper. Total size of all topic data including replicas on disk [bytes].

data_in_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [bytes/s].

data_out_bytes_per_secinteger (int64)

Is unavailable without Zookeeper. Data read from the brokers [bytes/s].

data_in_messages_per_secinteger (int64)

Is unavailable without Zookeeper. Data written to the brokers [msg/s].

updated_at*string (date-time)

apps*AgentAppsMetrics (object)

Is a part of AgentMetrics. Contains Apps metrics.

num_consumers*integer

num_other_apps*integer

updated_at*string (date-time)

connect*AgentConnectMetrics (object)

Is a part of AgentMetrics. Contains Kafka Connect metrics.

num_clusters*integer

num_connectors*integer

updated_at*string (date-time)

other*AgentOtherMetrics (object)

Is a part of AgentMetrics. Contains miscellaneous metrics.

num_issues*integer

updated_at*string (date-time)

metadataMetadata (object)

Allows attaching custom string key/values to resources. The following maxima apply:

50 keys/values;
40 bytes key length;
500 bytes value length.

Other propertiesstring

Request

Response

Retrieves a list of datasets

GEThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets

Path parameters

name*string

Query parameters

pageinteger

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

Example: 1

pageSize*integer

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

Example: 25

querystring

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

Example: "name"

connectionsarray of string

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

itemsstring

tagsarray of string

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

itemsstring

sortByDatasetField (enum)

The field to sort results by

sortingOrderOrder (enum)

Sorting order. Defaults to ascending

ascdesc

includeSystemEntitiesboolean

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

includeMetadataboolean

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

formatarray of string

Schema format. Relevant only when sourceType is SchemaRegistrySubject

itemsstring

hasRecordsboolean

Filter based on whether the dataset has records

compactedboolean

Filter based on compacted. Relevant only when sourceType is Kafka

Response

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

Body

datasets*Page_DatasetMatch (object)

valuesarray of Kafka (object)

name*string

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

recordsinteger (int64)

recordsPerSecond*integer (int64)

keyType*string

valueType*string

connectionName*string

replication*integer

consumers*integer

partitions*integer

fieldsFields (object)

keyarray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

valuearray of Field (object)

name*string

typestring

typeDetails*FieldTypeDetails (one of)

lensesDataType*string

descriptionstring

ancestorsarray of string

itemsstring

highlightsarray of Highlight (object)

fieldName*string

startIndex*integer

endIndex*integer

arrayIndex*integer

isNullable*boolean

defaultstring

isSystemEntity*boolean

isMarkedForDeletion*boolean

isCompacted*boolean

sizeBytesinteger (int64)

policiesarray of PolicyMatchDetails (object)

policyId*string

policyName*string

policyCategory*string

obfuscation*string

matchingKeyFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

matchingValueFieldsarray of PolicyFieldMatch (object)

name*string

parentsarray of string

itemsstring

permissions*array of string

itemsstring

descriptionstring

tagsarray of DatasetTag (object)

name*string

count*number

retentionMsinteger (int64)

retentionBytesinteger (int64)

backupRestoreStateBackupRestoreState (one of)

sourceType*string

pagesAmount*integer (int64)

totalCount*integer (int64)

sourceTypesarray of SourceType (enum)

itemsSourceType (enum)

KafkaElasticPostgresSchemaRegistrySubject

Request

Response

Returns the intellisense result for a given query

POSThttps://api.example.com/api/v1/environments/{name}/proxy/api/v1/sql/presentation

Path parameters

name*string

Body

sql*string

caretinteger

connectorIdstring

Response

Happy response

Body

input*string

caret*integer

lintsarray of Lint (object)

start*integer

end*integer

text*string

type*HintType (enum)

WarningErrorObfuscationInfoSecurity

suggestionsarray of Suggestion (object)

display*string

text*string

start*integer

end*integer

type*string

descriptionstring

highlightStart*integer

highlightEnd*integer

highlightsarray of Highlight1 (object)

start*integer

end*integer

text*string

type*HighlightType (enum)

KeywordStringIntegralFloatBooleanType

tablesarray of TableFields (object)

tableName*TableName (object)

value*string

fieldsarray of FieldName (object)

value*string

statementsPositionsarray of StatementPos (object)

index*integer

start*integer

end*integer

Request

Response

const response = await fetch('https://api.example.com/api/v1/environments/live/sse', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "type": "not_found",
  "title": "text",
  "status": 0,
  "invalid_fields": [
    {
      "name": "text",
      "error": "reference_not_found",
      "title": "text"
    }
  ],
  "sso_url": "text",
  "request_id": "text"
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}/proxy/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "type": "not_found",
  "title": "text",
  "status": 0,
  "invalid_fields": [
    {
      "name": "text",
      "error": "reference_not_found",
      "title": "text"
    }
  ],
  "sso_url": "text",
  "request_id": "text"
}

const response = await fetch('https://api.example.com/api/v1/environments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "items": [
    {
      "name": "text",
      "display_name": "text",
      "lrn": "text",
      "id": "text",
      "created_at": "2025-01-17T13:31:17.618Z",
      "tier": "development",
      "status": {
        "agent_connected": false,
        "agent": {
          "updated_at": "2025-01-17T13:31:17.618Z",
          "roundtrip_duration": 0,
          "agent": {
            "hostname": "text",
            "version": "text"
          },
          "metrics": {
            "kafka": {
              "version": "text",
              "num_brokers": 0,
              "updated_at": "2025-01-17T13:31:17.618Z"
            },
            "data": {
              "num_topics": 0,
              "num_partitions": 0,
              "num_schemas": 0,
              "num_policies": 0,
              "topic_data_total_bytes": 0,
              "data_in_bytes_per_sec": 0,
              "data_out_bytes_per_sec": 0,
              "data_in_messages_per_sec": 0,
              "updated_at": "2025-01-17T13:31:17.618Z"
            },
            "apps": {
              "num_consumers": 0,
              "num_other_apps": 0,
              "updated_at": "2025-01-17T13:31:17.618Z"
            },
            "connect": {
              "num_clusters": 0,
              "num_connectors": 0,
              "updated_at": "2025-01-17T13:31:17.618Z"
            },
            "other": {
              "num_issues": 0,
              "updated_at": "2025-01-17T13:31:17.618Z"
            }
          }
        }
      }
    }
  ]
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "name": "text",
  "display_name": "text",
  "lrn": "text",
  "id": "text",
  "created_at": "2025-01-17T13:31:17.618Z",
  "tier": "development",
  "status": {
    "agent_connected": false,
    "agent": {
      "updated_at": "2025-01-17T13:31:17.618Z",
      "roundtrip_duration": 0,
      "agent": {
        "hostname": "text",
        "version": "text"
      },
      "metrics": {
        "kafka": {
          "version": "text",
          "num_brokers": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "data": {
          "num_topics": 0,
          "num_partitions": 0,
          "num_schemas": 0,
          "num_policies": 0,
          "topic_data_total_bytes": 0,
          "data_in_bytes_per_sec": 0,
          "data_out_bytes_per_sec": 0,
          "data_in_messages_per_sec": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "apps": {
          "num_consumers": 0,
          "num_other_apps": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "connect": {
          "num_clusters": 0,
          "num_connectors": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "other": {
          "num_issues": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        }
      }
    }
  }
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "not_found",
  "title": "text",
  "status": 0,
  "invalid_fields": [
    {
      "name": "text",
      "error": "reference_not_found",
      "title": "text"
    }
  ],
  "sso_url": "text",
  "request_id": "text"
}

const response = await fetch('https://api.example.com/api/v1/environments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "tier": "development"
    }),
});
const data = await response.json();

{
  "name": "text",
  "display_name": "text",
  "lrn": "text",
  "id": "text",
  "created_at": "2025-01-17T13:31:17.618Z",
  "tier": "development",
  "status": {
    "agent_connected": false,
    "agent": {
      "updated_at": "2025-01-17T13:31:17.618Z",
      "roundtrip_duration": 0,
      "agent": {
        "hostname": "text",
        "version": "text"
      },
      "metrics": {
        "kafka": {
          "version": "text",
          "num_brokers": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "data": {
          "num_topics": 0,
          "num_partitions": 0,
          "num_schemas": 0,
          "num_policies": 0,
          "topic_data_total_bytes": 0,
          "data_in_bytes_per_sec": 0,
          "data_out_bytes_per_sec": 0,
          "data_in_messages_per_sec": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "apps": {
          "num_consumers": 0,
          "num_other_apps": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "connect": {
          "num_clusters": 0,
          "num_connectors": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "other": {
          "num_issues": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        }
      }
    }
  },
  "agent_key": "text"
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "tags": [
    {
      "name": "text",
      "count": 0
    }
  ]
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets/{connection}/{dataset}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "name": "text",
  "highlights": [
    {
      "fieldName": "text",
      "startIndex": 0,
      "endIndex": 0,
      "arrayIndex": 0
    }
  ],
  "records": 0,
  "recordsPerSecond": 0,
  "keyType": "text",
  "valueType": "text",
  "connectionName": "text",
  "replication": 0,
  "consumers": 0,
  "partitions": 0,
  "fields": {
    "key": [
      {
        "name": "text",
        "type": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 0,
            "endIndex": 0,
            "arrayIndex": 0
          }
        ],
        "isNullable": false,
        "default": "text"
      }
    ],
    "value": [
      {
        "name": "text",
        "type": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 0,
            "endIndex": 0,
            "arrayIndex": 0
          }
        ],
        "isNullable": false,
        "default": "text"
      }
    ]
  },
  "isSystemEntity": false,
  "isMarkedForDeletion": false,
  "isCompacted": false,
  "sizeBytes": 0,
  "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": 0
    }
  ],
  "retentionMs": 0,
  "retentionBytes": 0,
  "sourceType": "text"
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "name": "text",
  "display_name": "text",
  "lrn": "text",
  "id": "text",
  "created_at": "2025-01-17T13:31:17.618Z",
  "tier": "development",
  "status": {
    "agent_connected": false,
    "agent": {
      "updated_at": "2025-01-17T13:31:17.618Z",
      "roundtrip_duration": 0,
      "agent": {
        "hostname": "text",
        "version": "text"
      },
      "metrics": {
        "kafka": {
          "version": "text",
          "num_brokers": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "data": {
          "num_topics": 0,
          "num_partitions": 0,
          "num_schemas": 0,
          "num_policies": 0,
          "topic_data_total_bytes": 0,
          "data_in_bytes_per_sec": 0,
          "data_out_bytes_per_sec": 0,
          "data_in_messages_per_sec": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "apps": {
          "num_consumers": 0,
          "num_other_apps": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "connect": {
          "num_clusters": 0,
          "num_connectors": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        },
        "other": {
          "num_issues": 0,
          "updated_at": "2025-01-17T13:31:17.618Z"
        }
      }
    }
  }
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}/proxy/api/v1/datasets?pageSize=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "datasets": {
    "values": [
      {
        "name": "text",
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 0,
            "endIndex": 0,
            "arrayIndex": 0
          }
        ],
        "records": 0,
        "recordsPerSecond": 0,
        "keyType": "text",
        "valueType": "text",
        "connectionName": "text",
        "replication": 0,
        "consumers": 0,
        "partitions": 0,
        "fields": {
          "key": [
            {
              "name": "text",
              "type": "text",
              "typeDetails": {
                "lensesDataType": "text"
              },
              "description": "text",
              "ancestors": [
                "text"
              ],
              "highlights": [
                {
                  "fieldName": "text",
                  "startIndex": 0,
                  "endIndex": 0,
                  "arrayIndex": 0
                }
              ],
              "isNullable": false,
              "default": "text"
            }
          ],
          "value": [
            {
              "name": "text",
              "type": "text",
              "typeDetails": {
                "lensesDataType": "text"
              },
              "description": "text",
              "ancestors": [
                "text"
              ],
              "highlights": [
                {
                  "fieldName": "text",
                  "startIndex": 0,
                  "endIndex": 0,
                  "arrayIndex": 0
                }
              ],
              "isNullable": false,
              "default": "text"
            }
          ]
        },
        "isSystemEntity": false,
        "isMarkedForDeletion": false,
        "isCompacted": false,
        "sizeBytes": 0,
        "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": 0
          }
        ],
        "retentionMs": 0,
        "retentionBytes": 0,
        "sourceType": "text"
      }
    ],
    "pagesAmount": 0,
    "totalCount": 0
  },
  "sourceTypes": [
    "Kafka"
  ]
}

const response = await fetch('https://api.example.com/api/v1/environments/{name}/proxy/api/v1/sql/presentation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sql": "text"
    }),
});
const data = await response.json();

{
  "input": "text",
  "caret": 0,
  "lints": [
    {
      "start": 0,
      "end": 0,
      "text": "text",
      "type": "Warning"
    }
  ],
  "suggestions": [
    {
      "display": "text",
      "text": "text",
      "start": 0,
      "end": 0,
      "type": "text",
      "description": "text",
      "highlightStart": 0,
      "highlightEnd": 0
    }
  ],
  "highlights": [
    {
      "start": 0,
      "end": 0,
      "text": "text",
      "type": "Keyword"
    }
  ],
  "tables": [
    {
      "tableName": {
        "value": "text"
      },
      "fields": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "statementsPositions": [
    {
      "index": 0,
      "start": 0,
      "end": 0
    }
  ]
}