> For the complete documentation index, see [llms.txt](https://docs.lenses.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lenses.io/latest/api-reference/reference/models.md).

# Models

## The hq\_Error object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Error":{"type":"object","description":"Implements the RFC7807 \"Problem Details\", see https://www.rfc-editor.org/rfc/rfc7807.","properties":{"type":{"$ref":"#/components/schemas/hq_ErrorType"},"title":{"description":"Describes the problem in a human readable fashion.","type":"string"},"status":{"description":"Is a copy of the http status code.","type":"integer"},"invalid_fields":{"description":"Lists for validation errors the fields that failed validation.","type":"array","items":{"$ref":"#/components/schemas/hq_InvalidField"}},"sso_url":{"description":"Contains in case of an \"unauthorised\" type of error, the url of the SSO provider, if any.","type":"string"},"request_id":{"description":"Is set to the id of this request. Can be used to correlate backend logs.","type":"string"}},"required":["status","title"]},"hq_ErrorType":{"type":"string","description":"Enumerates possible error types.","enum":["not_found","unauthorised","forbidden","internal_server_error","agent_rpc_error","missing_agent_capabilities","agent_not_connected","validation_error","invalid_metadata","missing_parameter","invalid_parameter","licence_limitation","conflict","unspecified"]},"hq_InvalidField":{"type":"object","properties":{"name":{"type":"string"},"error":{"$ref":"#/components/schemas/hq_FieldErrorType"},"title":{"type":"string"},"pointer":{"description":"Holds a RFC-6901 JSON Pointer.","type":"string"}},"required":["name","error","title"]},"hq_FieldErrorType":{"type":"string","description":"Enumerates field validation error types.","enum":["reference_not_found","not_unique","invalid_value","other_error"]}}}}
```

## The hq\_ErrorType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ErrorType":{"type":"string","description":"Enumerates possible error types.","enum":["not_found","unauthorised","forbidden","internal_server_error","agent_rpc_error","missing_agent_capabilities","agent_not_connected","validation_error","invalid_metadata","missing_parameter","invalid_parameter","licence_limitation","conflict","unspecified"]}}}}
```

## The hq\_InvalidField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_InvalidField":{"type":"object","properties":{"name":{"type":"string"},"error":{"$ref":"#/components/schemas/hq_FieldErrorType"},"title":{"type":"string"},"pointer":{"description":"Holds a RFC-6901 JSON Pointer.","type":"string"}},"required":["name","error","title"]},"hq_FieldErrorType":{"type":"string","description":"Enumerates field validation error types.","enum":["reference_not_found","not_unique","invalid_value","other_error"]}}}}
```

## The hq\_FieldErrorType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_FieldErrorType":{"type":"string","description":"Enumerates field validation error types.","enum":["reference_not_found","not_unique","invalid_value","other_error"]}}}}
```

## The hq\_AgentError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentError":{"description":"This error is transferred from Agent API","required":["error"],"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/hq_AgentFieldError"}},"error":{"type":"string"},"errorType":{"type":"string"}}},"hq_AgentFieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"}}}}}}
```

## The hq\_AgentFieldError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentFieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"}}}}}}
```

## The hq\_Environment object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Environment":{"type":"object","description":"Represents a Lenses Instance, somewhere.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"tier":{"$ref":"#/components/schemas/hq_Tier"},"status":{"$ref":"#/components/schemas/hq_LiveEnvironmentInfo"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","tier","status"]},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_LiveEnvironmentInfo":{"type":"object","description":"Contains dynamic properties of the Agent, brought in via a connected\nagent. Only when the agent is connected to HQ, agent info can be\nupdated. An environment that never had a connected agent cannot have a\nLiveAgentInfo.\n","properties":{"agent_connected":{"type":"boolean","description":"Signals whether an agent is currently connected."},"agent":{"$ref":"#/components/schemas/hq_LiveAgentInfo","description":"Initialised on first agent connect, and updated only while connected."}},"required":["agent_connected"]},"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_Tier object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]}}}}
```

## The hq\_EnvironmentList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EnvironmentList":{"type":"object","description":"Contains a list of Environments.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_Environment"}}},"required":["items"]},"hq_Environment":{"type":"object","description":"Represents a Lenses Instance, somewhere.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"tier":{"$ref":"#/components/schemas/hq_Tier"},"status":{"$ref":"#/components/schemas/hq_LiveEnvironmentInfo"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","tier","status"]},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_LiveEnvironmentInfo":{"type":"object","description":"Contains dynamic properties of the Agent, brought in via a connected\nagent. Only when the agent is connected to HQ, agent info can be\nupdated. An environment that never had a connected agent cannot have a\nLiveAgentInfo.\n","properties":{"agent_connected":{"type":"boolean","description":"Signals whether an agent is currently connected."},"agent":{"$ref":"#/components/schemas/hq_LiveAgentInfo","description":"Initialised on first agent connect, and updated only while connected."}},"required":["agent_connected"]},"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_EnvironmentLiveEventType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EnvironmentLiveEventType":{"type":"string","description":"Enumerates environment live event names emitted over SSE.","enum":["initial","upsert","delete"]}}}}
```

## The hq\_EnvironmentLiveItemsPayload object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EnvironmentLiveItemsPayload":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_Environment"}},"last_event_at":{"type":"string","format":"date-time","description":"Server emission timestamp."}},"required":["items","last_event_at"]},"hq_Environment":{"type":"object","description":"Represents a Lenses Instance, somewhere.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"tier":{"$ref":"#/components/schemas/hq_Tier"},"status":{"$ref":"#/components/schemas/hq_LiveEnvironmentInfo"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","tier","status"]},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_LiveEnvironmentInfo":{"type":"object","description":"Contains dynamic properties of the Agent, brought in via a connected\nagent. Only when the agent is connected to HQ, agent info can be\nupdated. An environment that never had a connected agent cannot have a\nLiveAgentInfo.\n","properties":{"agent_connected":{"type":"boolean","description":"Signals whether an agent is currently connected."},"agent":{"$ref":"#/components/schemas/hq_LiveAgentInfo","description":"Initialised on first agent connect, and updated only while connected."}},"required":["agent_connected"]},"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_EnvironmentLiveDeletePayload object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EnvironmentLiveDeletePayload":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Environment identifiers that were deleted."},"last_event_at":{"type":"string","format":"date-time","description":"Server emission timestamp."}},"required":["ids","last_event_at"]}}}}
```

## The hq\_LiveEnvironmentInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LiveEnvironmentInfo":{"type":"object","description":"Contains dynamic properties of the Agent, brought in via a connected\nagent. Only when the agent is connected to HQ, agent info can be\nupdated. An environment that never had a connected agent cannot have a\nLiveAgentInfo.\n","properties":{"agent_connected":{"type":"boolean","description":"Signals whether an agent is currently connected."},"agent":{"$ref":"#/components/schemas/hq_LiveAgentInfo","description":"Initialised on first agent connect, and updated only while connected."}},"required":["agent_connected"]},"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]}}}}
```

## The hq\_LiveAgentInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]}}}}
```

## The hq\_LensesAgentSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]}}}}
```

## The hq\_AgentCapabilities object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]}}}}
```

## The hq\_AgentMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]}}}}
```

## The hq\_AgentKafkaMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]}}}}
```

## The hq\_AgentDataMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]}}}}
```

## The hq\_AgentAppsMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]}}}}
```

## The hq\_AgentConnectMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]}}}}
```

## The hq\_AgentOtherMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]}}}}
```

## The hq\_UpsertKafkaConnectionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpsertKafkaConnectionRequest":{"description":"Creates/updates a Kafka connection.","type":"object","properties":{"display_name":{"type":"string","maxLength":150,"description":"Sets the display name of the new KafkaConnection. If not provided,\nthe value of \"name\" will be used.\n"},"description":{"type":"string","description":"Has the optional description of the object.","maxLength":280},"override_broker_addresses":{"description":"Optionally overrides the broker addresses. If not set, those of the agent are used.","type":"array","items":{"type":"string"}},"auth":{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettings"}},"required":["auth"]},"hq_KafkaConnectionAuthSettings":{"description":"Contains auth settings specific to a particular auth type.","oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}],"discriminator":{"propertyName":"type","mapping":{"plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext","aws_iam":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM","mtls":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS","sasl_ssl":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL","sasl_plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}}},"hq_KafkaConnectionAuthSettingsPlaintext":{"type":"object","description":"Configures Kafka Plaintext \"authentication\".","required":[]},"hq_KafkaConnectionAuthSettingsAWSIAM":{"type":"object","description":"Configures Kafka AWS IAM authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"service_account":{"type":"string","description":"Holds the Kubernetes service account name for IRSA.","format":"K8sDns1123Subdomain"}},"required":["kubernetes_namespace_lrn","service_account"]},"hq_KafkaConnectionAuthSettingsMTLS":{"type":"object","description":"Configures Kafka mTLS authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"keystore":{"$ref":"#/components/schemas/hq_K8sKeystoreRef"},"truststore":{"$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","keystore"]},"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLSSL":{"type":"object","description":"Configures Kafka SASL authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"},"truststore":{"description":"Custom TLS truststore. When omitted, the JVM default truststore\n(built-in CA certificates) is used.\n","$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLPlaintext":{"type":"object","description":"Configures Kafka SASL authentication without TLS (security.protocol SASL_PLAINTEXT).","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]}}}}
```

## The hq\_KafkaConnection object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnection":{"description":"Defines Kafka connection settings for applications.","type":"object","properties":{"name":{"type":"string","format":"hq-resource-name","description":"Uniquely identifies a connection within an environment."},"display_name":{"type":"string","maxLength":150},"lrn":{"type":"string","description":"Contains the resource identifier."},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"created_at":{"format":"date-time","type":"string"},"override_broker_addresses":{"description":"Optionally overrides the broker addresses. If not set, those of the agent are used.","type":"array","items":{"type":"string"}},"auth":{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettings"}},"required":["name","display_name","description","created_at","lrn","auth"]},"hq_KafkaConnectionAuthSettings":{"description":"Contains auth settings specific to a particular auth type.","oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}],"discriminator":{"propertyName":"type","mapping":{"plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext","aws_iam":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM","mtls":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS","sasl_ssl":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL","sasl_plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}}},"hq_KafkaConnectionAuthSettingsPlaintext":{"type":"object","description":"Configures Kafka Plaintext \"authentication\".","required":[]},"hq_KafkaConnectionAuthSettingsAWSIAM":{"type":"object","description":"Configures Kafka AWS IAM authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"service_account":{"type":"string","description":"Holds the Kubernetes service account name for IRSA.","format":"K8sDns1123Subdomain"}},"required":["kubernetes_namespace_lrn","service_account"]},"hq_KafkaConnectionAuthSettingsMTLS":{"type":"object","description":"Configures Kafka mTLS authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"keystore":{"$ref":"#/components/schemas/hq_K8sKeystoreRef"},"truststore":{"$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","keystore"]},"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLSSL":{"type":"object","description":"Configures Kafka SASL authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"},"truststore":{"description":"Custom TLS truststore. When omitted, the JVM default truststore\n(built-in CA certificates) is used.\n","$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLPlaintext":{"type":"object","description":"Configures Kafka SASL authentication without TLS (security.protocol SASL_PLAINTEXT).","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]}}}}
```

## The hq\_KafkaConnectionAuthSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettings":{"description":"Contains auth settings specific to a particular auth type.","oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}],"discriminator":{"propertyName":"type","mapping":{"plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext","aws_iam":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM","mtls":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS","sasl_ssl":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL","sasl_plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}}},"hq_KafkaConnectionAuthSettingsPlaintext":{"type":"object","description":"Configures Kafka Plaintext \"authentication\".","required":[]},"hq_KafkaConnectionAuthSettingsAWSIAM":{"type":"object","description":"Configures Kafka AWS IAM authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"service_account":{"type":"string","description":"Holds the Kubernetes service account name for IRSA.","format":"K8sDns1123Subdomain"}},"required":["kubernetes_namespace_lrn","service_account"]},"hq_KafkaConnectionAuthSettingsMTLS":{"type":"object","description":"Configures Kafka mTLS authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"keystore":{"$ref":"#/components/schemas/hq_K8sKeystoreRef"},"truststore":{"$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","keystore"]},"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLSSL":{"type":"object","description":"Configures Kafka SASL authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"},"truststore":{"description":"Custom TLS truststore. When omitted, the JVM default truststore\n(built-in CA certificates) is used.\n","$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLPlaintext":{"type":"object","description":"Configures Kafka SASL authentication without TLS (security.protocol SASL_PLAINTEXT).","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]}}}}
```

## The hq\_KafkaConnectionAuthSettingsPlaintext object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettingsPlaintext":{"type":"object","description":"Configures Kafka Plaintext \"authentication\".","required":[]}}}}
```

## The hq\_KafkaConnectionAuthSettingsAWSIAM object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettingsAWSIAM":{"type":"object","description":"Configures Kafka AWS IAM authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"service_account":{"type":"string","description":"Holds the Kubernetes service account name for IRSA.","format":"K8sDns1123Subdomain"}},"required":["kubernetes_namespace_lrn","service_account"]}}}}
```

## The hq\_KafkaConnectionAuthSettingsMTLS object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettingsMTLS":{"type":"object","description":"Configures Kafka mTLS authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"keystore":{"$ref":"#/components/schemas/hq_K8sKeystoreRef"},"truststore":{"$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","keystore"]},"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]}}}}
```

## The hq\_KafkaConnectionAuthSettingsSASLSSL object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettingsSASLSSL":{"type":"object","description":"Configures Kafka SASL authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"},"truststore":{"description":"Custom TLS truststore. When omitted, the JVM default truststore\n(built-in CA certificates) is used.\n","$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]}}}}
```

## The hq\_KafkaConnectionAuthSettingsSASLPlaintext object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionAuthSettingsSASLPlaintext":{"type":"object","description":"Configures Kafka SASL authentication without TLS (security.protocol SASL_PLAINTEXT).","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]}}}}
```

## The hq\_KafkaConnectionSASLCredentials object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]}}}}
```

## The hq\_KafkaConnectionSASLUsernamePasswordRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_KafkaConnectionSASLJAASConfigRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_KubernetesSecretKeyReference object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_K8sKeystoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]}}}}
```

## The hq\_K8sPKCS12KeystoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_K8sPEMKeystoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_K8sTruststoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]}}}}
```

## The hq\_K8sPKCS12TruststoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_K8sPEMTruststoreRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]}}}}
```

## The hq\_SASLMechanism object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]}}}}
```

## The hq\_KafkaConnectionList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaConnectionList":{"type":"object","description":"Contains a list of KafkaConnections.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_KafkaConnection"}}},"required":["items"]},"hq_KafkaConnection":{"description":"Defines Kafka connection settings for applications.","type":"object","properties":{"name":{"type":"string","format":"hq-resource-name","description":"Uniquely identifies a connection within an environment."},"display_name":{"type":"string","maxLength":150},"lrn":{"type":"string","description":"Contains the resource identifier."},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"created_at":{"format":"date-time","type":"string"},"override_broker_addresses":{"description":"Optionally overrides the broker addresses. If not set, those of the agent are used.","type":"array","items":{"type":"string"}},"auth":{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettings"}},"required":["name","display_name","description","created_at","lrn","auth"]},"hq_KafkaConnectionAuthSettings":{"description":"Contains auth settings specific to a particular auth type.","oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL"},{"$ref":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}],"discriminator":{"propertyName":"type","mapping":{"plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsPlaintext","aws_iam":"#/components/schemas/hq_KafkaConnectionAuthSettingsAWSIAM","mtls":"#/components/schemas/hq_KafkaConnectionAuthSettingsMTLS","sasl_ssl":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLSSL","sasl_plaintext":"#/components/schemas/hq_KafkaConnectionAuthSettingsSASLPlaintext"}}},"hq_KafkaConnectionAuthSettingsPlaintext":{"type":"object","description":"Configures Kafka Plaintext \"authentication\".","required":[]},"hq_KafkaConnectionAuthSettingsAWSIAM":{"type":"object","description":"Configures Kafka AWS IAM authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"service_account":{"type":"string","description":"Holds the Kubernetes service account name for IRSA.","format":"K8sDns1123Subdomain"}},"required":["kubernetes_namespace_lrn","service_account"]},"hq_KafkaConnectionAuthSettingsMTLS":{"type":"object","description":"Configures Kafka mTLS authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"keystore":{"$ref":"#/components/schemas/hq_K8sKeystoreRef"},"truststore":{"$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","keystore"]},"hq_K8sKeystoreRef":{"description":"References Kubernetes secrets for a keystore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12KeystoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMKeystoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12KeystoreRef","pem":"#/components/schemas/hq_K8sPEMKeystoreRef"}}},"hq_K8sPKCS12KeystoreRef":{"type":"object","description":"References Kubernetes secrets for a keystore: the store itself in PKCS12\nencoding and its password. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.p12\" the store and key \"user.password\" the store's\npassword.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_KubernetesSecretKeyReference":{"type":"object","description":"Contains a reference to a particular key within a Kubernetes secret. The\nnamespace is expected to be defined elsewhere.\n","properties":{"secret_name":{"type":"string","description":"Holds the Kubernetes Secret's name.","format":"K8sDns1123Subdomain"},"secret_key":{"type":"string","description":"Has the name of the key within the Kubernetes Secret.","format":"K8sSecretKey"}},"required":["secret_name","secret_key"]},"hq_K8sPEMKeystoreRef":{"type":"object","description":"References Kubernetes secrets for a \"keystore\" in PEM encoding: a public\ncertificate and a private key. For Strimzi, the secret name would be the\nsame as the corresponding Kafka user (kafkausers.kafka.strimzi.io CRD),\nwith key \"user.crt\" the cert and key \"user.key\" the key.\n","properties":{"cert":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"key":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["cert","key"]},"hq_K8sTruststoreRef":{"description":"References Kubernetes secrets for a truststore in either PEM or PKCS12\nencoding.\n","oneOf":[{"$ref":"#/components/schemas/hq_K8sPKCS12TruststoreRef"},{"$ref":"#/components/schemas/hq_K8sPEMTruststoreRef"}],"discriminator":{"propertyName":"type","mapping":{"pkcs12":"#/components/schemas/hq_K8sPKCS12TruststoreRef","pem":"#/components/schemas/hq_K8sPEMTruststoreRef"}}},"hq_K8sPKCS12TruststoreRef":{"type":"object","description":"References Kubernetes secrets for a truststore: the store itself in\nPKCS12 encoding and its password. For Strimzi, the secret name would\nhave the form of \"<cluster-name>-cluster-ca-cert\", with key \"ca.p12\" the\nstore and key \"ca.password\" the password.\n","properties":{"store":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["store","password"]},"hq_K8sPEMTruststoreRef":{"description":"References a Kubernetes secret for a \"truststore\" in PEM encoding which\ncomes down to one or more certificates. For Strimzi, the secret name\nwould have the form of \"<cluster-name>-cluster-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n","allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLSSL":{"type":"object","description":"Configures Kafka SASL authentication.","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"},"truststore":{"description":"Custom TLS truststore. When omitted, the JVM default truststore\n(built-in CA certificates) is used.\n","$ref":"#/components/schemas/hq_K8sTruststoreRef"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]},"hq_SASLMechanism":{"type":"string","description":"Enumerates supported SASL mechanisms.","enum":["plain","scram_sha_256","scram_sha_512"]},"hq_KafkaConnectionSASLCredentials":{"oneOf":[{"$ref":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef"},{"$ref":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}],"discriminator":{"propertyName":"type","mapping":{"username_password":"#/components/schemas/hq_KafkaConnectionSASLUsernamePasswordRef","jaas_config":"#/components/schemas/hq_KafkaConnectionSASLJAASConfigRef"}}},"hq_KafkaConnectionSASLUsernamePasswordRef":{"type":"object","properties":{"username":{"type":"string","minLength":1},"password":{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"}},"required":["username","password"]},"hq_KafkaConnectionSASLJAASConfigRef":{"allOf":[{"$ref":"#/components/schemas/hq_KubernetesSecretKeyReference"},{"type":"object","properties":{}}]},"hq_KafkaConnectionAuthSettingsSASLPlaintext":{"type":"object","description":"Configures Kafka SASL authentication without TLS (security.protocol SASL_PLAINTEXT).","properties":{"kubernetes_namespace_lrn":{"type":"string","format":"kubernetes-namespace-lrn","description":"Determines the Kubernetes deployment namespace to which those settings apply."},"mechanism":{"$ref":"#/components/schemas/hq_SASLMechanism"},"credentials":{"$ref":"#/components/schemas/hq_KafkaConnectionSASLCredentials"}},"required":["kubernetes_namespace_lrn","mechanism","credentials"]}}}}
```

## The hq\_CreateEnvironmentRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateEnvironmentRequest":{"type":"object","properties":{"name":{"type":"string","format":"hq-resource-name","description":"Sets the name of the new environment. It must be a valid HQ resource\nname: it can only contain lowercase alphanumeric characters or\nhyphens; hyphens cannot appear at the end or start; the length is 63\ncharacters at most.\n","minLength":1,"maxLength":63},"display_name":{"type":"string","description":"Sets the display name of the new environment. If not provided, the\nvalue of \"name\" will be used.\n","minLength":1,"maxLength":150},"tier":{"$ref":"#/components/schemas/hq_Tier"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","tier"]},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_UpdateEnvironmentRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateEnvironmentRequest":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/hq_Tier"},"metadata":{"$ref":"#/components/schemas/hq_MetadataPatchRequest"},"display_name":{"type":"string","description":"Updates the display name of the environment.","minLength":1,"maxLength":150}}},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_NewEnvironmentWithKey object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_NewEnvironmentWithKey":{"description":"Is returned on creation, contains the agent key but lacks dynamic fields which are unavailble on creation by definition.","allOf":[{"$ref":"#/components/schemas/hq_Environment"},{"type":"object","properties":{"agent_key":{"type":"string","format":"password"}},"required":["agent_key"]}]},"hq_Environment":{"type":"object","description":"Represents a Lenses Instance, somewhere.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"tier":{"$ref":"#/components/schemas/hq_Tier"},"status":{"$ref":"#/components/schemas/hq_LiveEnvironmentInfo"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","tier","status"]},"hq_Tier":{"type":"string","description":"Enumerates Tiers.","enum":["development","staging","production"]},"hq_LiveEnvironmentInfo":{"type":"object","description":"Contains dynamic properties of the Agent, brought in via a connected\nagent. Only when the agent is connected to HQ, agent info can be\nupdated. An environment that never had a connected agent cannot have a\nLiveAgentInfo.\n","properties":{"agent_connected":{"type":"boolean","description":"Signals whether an agent is currently connected."},"agent":{"$ref":"#/components/schemas/hq_LiveAgentInfo","description":"Initialised on first agent connect, and updated only while connected."}},"required":["agent_connected"]},"hq_LiveAgentInfo":{"type":"object","description":"Is a collection of fields related to an agent. Updated only when an agent is connected.\n","properties":{"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"connected_at":{"format":"date-time","type":"string","description":"Contains the time instant the agent connected to HQ."},"roundtrip_duration":{"type":"number","format":"double","description":"Is measured in seconds."},"agent":{"$ref":"#/components/schemas/hq_LensesAgentSummary"},"metrics":{"$ref":"#/components/schemas/hq_AgentMetrics"}},"required":["updated_at","roundtrip_duration","agent"]},"hq_LensesAgentSummary":{"type":"object","description":"Bundles information about the agent.","properties":{"hostname":{"type":"string","description":"Is set to the hostname of the machine the agent runs on."},"version":{"type":"string","description":"Contains the version of the agent executable."},"protocol_version":{"type":"string","description":"Contains the internal protocol version implemented by the agent."},"capabilities":{"$ref":"#/components/schemas/hq_AgentCapabilities"}},"required":["hostname","version","capabilities","protocol_version"]},"hq_AgentCapabilities":{"type":"object","description":"Exposes capabilities of this particular agent.","properties":{"metrics":{"type":"boolean","description":"Is set to true if the agent can provide metrics."},"k2k":{"type":"boolean","description":"Is set to true if the agent can do Kafka2kafka."},"publish":{"type":"boolean","description":"Is set to true if the agent can publish to Kafka."}},"required":["metrics","k2k","publish"]},"hq_AgentMetrics":{"type":"object","description":"Bundles several categories of agent metrics.","properties":{"kafka":{"$ref":"#/components/schemas/hq_AgentKafkaMetrics"},"data":{"$ref":"#/components/schemas/hq_AgentDataMetrics"},"apps":{"$ref":"#/components/schemas/hq_AgentAppsMetrics"},"connect":{"$ref":"#/components/schemas/hq_AgentConnectMetrics"},"other":{"$ref":"#/components/schemas/hq_AgentOtherMetrics"}},"required":[]},"hq_AgentKafkaMetrics":{"type":"object","description":"Is optionally part of AgentMetrics. Contains Kafka-specific metrics.\nUnavailable if Zoopeeker is not configured.\n","properties":{"version":{"type":"string"},"num_brokers":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["version","num_brokers","updated_at"]},"hq_AgentDataMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Data related metrics.","properties":{"num_topics":{"type":"integer"},"num_partitions":{"type":"integer"},"num_schemas":{"type":"integer"},"num_policies":{"type":"integer"},"topic_data_total_bytes":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Total size of all topic data including\nreplicas on disk [bytes].\n"},"data_in_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [bytes/s].\n"},"data_out_bytes_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data read from the brokers [bytes/s].\n"},"data_in_messages_per_sec":{"type":"integer","format":"int64","description":"Is unavailable without Zookeeper. Data written to the brokers [msg/s].\n"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_topics","num_partitions","num_schemas","num_policies","updated_at"]},"hq_AgentAppsMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Apps metrics.","properties":{"num_consumers":{"type":"integer"},"num_other_apps":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_consumers","num_other_apps","updated_at"]},"hq_AgentConnectMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains Kafka Connect metrics.","properties":{"num_clusters":{"type":"integer"},"num_connectors":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_clusters","num_connectors","updated_at"]},"hq_AgentOtherMetrics":{"type":"object","description":"Is a part of AgentMetrics. Contains miscellaneous metrics.","properties":{"num_issues":{"type":"integer"},"updated_at":{"type":"string","format":"date-time"}},"required":["num_issues","updated_at"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CompactGroup object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_Group object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Group":{"type":"object","description":"Contains Users and Service accounts, and the Roles assigned to it.","properties":{"name":{"type":"string","description":"Holds the name of the Group. Must be unique."},"display_name":{"type":"string","description":"Holds the display name of the Group."},"sso_name":{"type":"string","description":"Holds the SSO name of the Group."},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactRole"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactUser"}},"service_accounts":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactServiceAccount"}},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","roles","users","service_accounts"]},"hq_CompactRole":{"type":"object","description":"Represents a Role in a compact way.","properties":{"name":{"description":"Holds the unique name of this role.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"description":{"type":"string","description":"Contains the description of the role."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"policy_length":{"description":"Is set to the number of PermissionStatements in the Policy.","type":"integer"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","description","id","created_at","policy_length"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}},"hq_CompactUser":{"type":"object","description":"Represents a User in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"profile":{"$ref":"#/components/schemas/hq_UserProfile"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","profile","is_admin"]},"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]},"hq_CompactServiceAccount":{"type":"object","description":"Represents a ServiceAccount in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","is_admin"]}}}}
```

## The hq\_CompactGroupList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactGroupList":{"type":"object","description":"Contains a list of CompactGroups.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}}},"required":["items"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CreateGroupRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateGroupRequest":{"type":"object","properties":{"name":{"type":"string","format":"hq-resource-name","description":"Sets the unique name of the new group. It must be a valid HQ\nresource name: it can only contain lowercase alphanumeric characters\nor hyphens; hyphens cannot appear at the end or start; the length is\n63 characters at most.\n","minLength":1,"maxLength":63},"display_name":{"type":"string","description":"Sets the display name of the new group. If not provided, the value\nof \"name\" will be used.\n","minLength":1,"maxLength":150},"sso_name":{"type":"string","description":"Sets the SSO name of the new group. If not provided, the value of\n\"name\" will be used. When users sign in via SSO, this field is used\nto map SSO-provided groups onto HQ groups. Having a dedicated field\nhelps in e.g. the Active Directory situation, where the groups in\nthe SAML assertion are passed as UUIDs. E.g., one can have a group\nnamed \"my-group\" with display_name \"My Group of Lovely People\" and\nsso_name \"f3f2e850-b5d4-11ef-ac7e-96584d5248b2\".\n","minLength":1,"maxLength":150},"description":{"type":"string","description":"Sets the description of the new group.","maxLength":250},"members":{"description":"Lists principal names (users, service accounts) to be member of this group.","type":"array","items":{"type":"string"}},"roles":{"description":"Sets the Roles that are bound to this Group by name.","type":"array","items":{"type":"string"}},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_UpdateGroupRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateGroupRequest":{"type":"object","properties":{"display_name":{"type":"string","description":"Updates the display name of the group.","minLength":1,"maxLength":150},"sso_name":{"type":"string","description":"Updates the SSO name of the group.","minLength":1,"maxLength":150},"description":{"type":"string","maxLength":250,"description":"Updates the Group description, if a value is provided."},"roles":{"description":"Sets the Roles that are bound to this Group to the Roles (specified by their names), if provided.","type":"array","items":{"type":"string"}},"add_members":{"description":"Adds the users/principals (specified by their names) to this group, if provided.","type":"array","items":{"type":"string"}},"remove_members":{"description":"Removes the users/principals (specified by their names) from this\ngroup, if provided. If members are specified in both add_members as\nwell in here, removal wins.\n","type":"array","items":{"type":"string"}},"set_members":{"description":"Sets the members of this group to those users/principals (specified\nby their names) in an absolute fashion, if provided. Cannot be\ncombined with the add_members or remove_members fields.\n","type":"array","items":{"type":"string"}},"metadata":{"$ref":"#/components/schemas/hq_MetadataPatchRequest"}}},"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_User object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_User":{"type":"object","description":"Models an HQ user.","properties":{"name":{"description":"Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this user has interaction with the API."},"profile":{"$ref":"#/components/schemas/hq_UserProfile"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","groups","profile","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}},"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]}}}}
```

## The hq\_UserSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserSettings":{"type":"object","description":"Models a user's settings.","properties":{"data":{"$ref":"#/components/schemas/hq_UserData"}},"required":["data"]},"hq_UserData":{"type":"object","description":"Can store free-form data.","additionalProperties":{}}}}}
```

## The hq\_UserData object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserData":{"type":"object","description":"Can store free-form data.","additionalProperties":{}}}}}
```

## The hq\_UpdateUserSettingsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateUserSettingsRequest":{"type":"object","description":"Allows changes of a user's Settings. Absent fields are left untouched.\n","properties":{"data":{"$ref":"#/components/schemas/hq_UserDataPatch"}}},"hq_UserDataPatch":{"type":"object","description":"Patches user data. Keys can map to arbitrary values (object, string,\nnumber, boolean, etc.). It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{}}}}}
```

## The hq\_UserDataPatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserDataPatch":{"type":"object","description":"Patches user data. Keys can map to arbitrary values (object, string,\nnumber, boolean, etc.). It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{}}}}}
```

## The hq\_UserProfile object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]}}}}
```

## The hq\_UpdateUserProfileRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateUserProfileRequest":{"type":"object","description":"Allows changes of a user's Profile. Absent fields are left untouched.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string","maxLength":100},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string","maxLength":100}}}}}}
```

## The hq\_UserList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserList":{"type":"object","description":"Contains a list of Users.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_User"}}},"required":["items"]},"hq_User":{"type":"object","description":"Models an HQ user.","properties":{"name":{"description":"Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this user has interaction with the API."},"profile":{"$ref":"#/components/schemas/hq_UserProfile"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","groups","profile","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}},"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]}}}}
```

## The hq\_CompactUser object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactUser":{"type":"object","description":"Represents a User in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"profile":{"$ref":"#/components/schemas/hq_UserProfile"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","profile","is_admin"]},"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CreateUserRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateUserRequest":{"type":"object","properties":{"name":{"type":"string","description":"Sets the unique name of the new user.\n","minLength":1,"maxLength":100},"display_name":{"description":"Sets the display name of the new user. If not provided, the value of\n\"name\" will be used.\n","type":"string","minLength":1,"maxLength":150},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_UpdateUserRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateUserRequest":{"type":"object","description":"Updates a user. Absent fields are left untouched.","properties":{"display_name":{"description":"Updates the display name of the user.","type":"string","minLength":1,"maxLength":150},"metadata":{"$ref":"#/components/schemas/hq_MetadataPatchRequest"}}},"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_SetGroupMembershipsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SetGroupMembershipsRequest":{"type":"object","description":"Defines the groups a user or service account should be exactly a member of.","properties":{"add_to_groups":{"description":"Adds the user or service account to the groups (specified by their names).\n","type":"array","items":{"type":"string"}},"remove_from_groups":{"description":"Removes the user or service account from the groups (specified by their names).\nIf a group is specified in both add_to_groups as well in here, removal wins.\n","type":"array","items":{"type":"string"}},"set_groups":{"type":"array","description":"Sets the user or service account memberships to those\ngroups (specified by their names) in an absolute fashion\n(ensures user/sa will be exactly a member of those), if\nprovided. Cannot be combined with the add_to_groups or remove_from_groups.\n","items":{"type":"string"}}}}}}}
```

## The hq\_ServiceAccount object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ServiceAccount":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"token_expires_at":{"type":"string","format":"date-time","description":"If null, it won't expire."},"token_expired":{"type":"boolean"},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this service account has interaction with the API."},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","description","groups","token_expired","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_ServiceAccountList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ServiceAccountList":{"type":"object","description":"Contains a list of ServiceAccounts.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_ServiceAccount"}}},"required":["items"]},"hq_ServiceAccount":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"token_expires_at":{"type":"string","format":"date-time","description":"If null, it won't expire."},"token_expired":{"type":"boolean"},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this service account has interaction with the API."},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","description","groups","token_expired","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_ServiceAccountWithSecretToken object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ServiceAccountWithSecretToken":{"allOf":[{"$ref":"#/components/schemas/hq_ServiceAccount"},{"type":"object","properties":{"token":{"type":"string","format":"password"}},"required":["token"]}]},"hq_ServiceAccount":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"token_expires_at":{"type":"string","format":"date-time","description":"If null, it won't expire."},"token_expired":{"type":"boolean"},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this service account has interaction with the API."},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","description","groups","token_expired","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CompactServiceAccount object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactServiceAccount":{"type":"object","description":"Represents a ServiceAccount in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","is_admin"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CreateServiceAccountRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateServiceAccountRequest":{"type":"object","properties":{"name":{"type":"string","description":"Sets the unique name of the new service account. It must be a valid\nHQ resource name: it can only contain lowercase alphanumeric\ncharacters or hyphens; hyphens cannot appear at the end or start;\nthe length is 63 characters at most.\n","minLength":1,"maxLength":63,"format":"hq-resource-name"},"display_name":{"description":"Sets | the display name of the new service account. If not provided, the value of \"name\" will be used.","type":"string","minLength":1,"maxLength":150},"description":{"type":"string","description":"Sets the description of the new service account.","maxLength":250},"token_expires_at":{"type":"string","format":"date-time","description":"Determines the moment of token expiration. If not specified, the token will never expire."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_UpdateServiceAccountRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateServiceAccountRequest":{"type":"object","description":"Updates a service account. Absent fields are left untouched.","properties":{"display_name":{"description":"Updates the display name of the service account.","type":"string","minLength":1,"maxLength":150},"description":{"type":"string","description":"Updates the description of a service account.","maxLength":250},"metadata":{"$ref":"#/components/schemas/hq_MetadataPatchRequest"}}},"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_RenewServiceAccountTokenRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_RenewServiceAccountTokenRequest":{"type":"object","properties":{"token_expires_at":{"type":"string","format":"date-time","description":"Determines the moment of token expiration. If not specified, the token will never expire."}}}}}}
```

## The hq\_UserOrServiceAccount object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UserOrServiceAccount":{"description":"Represents either a user or service account.","oneOf":[{"$ref":"#/components/schemas/hq_User"},{"$ref":"#/components/schemas/hq_ServiceAccount"}],"discriminator":{"propertyName":"object_type","mapping":{"user":"#/components/schemas/hq_User","service_account":"#/components/schemas/hq_ServiceAccount"}}},"hq_User":{"type":"object","description":"Models an HQ user.","properties":{"name":{"description":"Contains the canonical and unique user's user name. Potentially an implicit reference to a corresponding entity in an external system in case of SSO.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this user has interaction with the API."},"profile":{"$ref":"#/components/schemas/hq_UserProfile"},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","groups","profile","is_admin"]},"hq_CompactGroup":{"type":"object","description":"Represents a Group in a compact way.","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"sso_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"user_count":{"type":"integer","description":"Is set to the number of users in this group."},"sa_count":{"type":"integer","description":"Is set to the number of service accounts in this group."},"role_count":{"type":"integer","description":"Is set to the number of roles associated with this group."},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","sso_name","lrn","id","created_at","description","user_count","sa_count","role_count"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}},"hq_UserProfile":{"type":"object","description":"Models a user's Profile.","properties":{"full_name":{"description":"Contains the users' full name, e.g. Mary Jane Doe.","type":"string"},"email_address":{"description":"Contains the users' email address, e.g. mary.jane@doe.net. Note that\nthis is not necessarily the same as the user's name, which often\nlooks like an email address, but is not per se.\n","type":"string"}},"required":["full_name","email_address"]},"hq_ServiceAccount":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"created_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactGroup"}},"token_expires_at":{"type":"string","format":"date-time","description":"If null, it won't expire."},"token_expired":{"type":"boolean"},"last_seen_at":{"type":"string","format":"date-time","description":"Updates when this service account has interaction with the API."},"is_admin":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","id","created_at","description","groups","token_expired","is_admin"]}}}}
```

## The hq\_Role object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Role":{"type":"object","description":"Bundles a list of permission statements with a name.","properties":{"name":{"description":"Holds the unique name of this role.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"description":{"type":"string","description":"Contains the description of the role."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"policy":{"type":"array","items":{"$ref":"#/components/schemas/hq_PermissionStatement"}},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","description","id","created_at","policy"]},"hq_PermissionStatement":{"type":"object","description":"Describes the effect for an action and resource.","properties":{"effect":{"$ref":"#/components/schemas/hq_PermissionEffect"},"action":{"$ref":"#/components/schemas/hq_PermissionActionScalarOrList"},"resource":{"$ref":"#/components/schemas/hq_PermissionResourceScalarOrList"}},"required":["effect","action","resource"]},"hq_PermissionEffect":{"type":"string","description":"Enumerates permission effects.","enum":["allow","deny"]},"hq_PermissionActionScalarOrList":{"description":"Is either a single action or a list of actions.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_PermissionResourceScalarOrList":{"description":"Is either a single string or a list of strings.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CompactRole object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactRole":{"type":"object","description":"Represents a Role in a compact way.","properties":{"name":{"description":"Holds the unique name of this role.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"description":{"type":"string","description":"Contains the description of the role."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"policy_length":{"description":"Is set to the number of PermissionStatements in the Policy.","type":"integer"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","description","id","created_at","policy_length"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CreateRoleRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateRoleRequest":{"type":"object","description":"Contains the fields needed to create a role.","properties":{"name":{"type":"string","description":"Sets the unique name of the new role. It must be a valid HQ\nresource name: it can only contain lowercase alphanumeric characters\nor hyphens; hyphens cannot appear at the end or start; the length is\n63 characters at most.\n","minLength":1,"maxLength":63,"format":"hq-resource-name"},"display_name":{"type":"string","description":"Sets the display name of the new role. If not provided, the value of\n\"name\" will be used.\n","minLength":1,"maxLength":150},"description":{"type":"string","description":"Sets the description of the new role.","maxLength":280},"policy":{"type":"array","description":"Contains a list of permission statements.","items":{"$ref":"#/components/schemas/hq_PermissionStatement"}},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","policy"]},"hq_PermissionStatement":{"type":"object","description":"Describes the effect for an action and resource.","properties":{"effect":{"$ref":"#/components/schemas/hq_PermissionEffect"},"action":{"$ref":"#/components/schemas/hq_PermissionActionScalarOrList"},"resource":{"$ref":"#/components/schemas/hq_PermissionResourceScalarOrList"}},"required":["effect","action","resource"]},"hq_PermissionEffect":{"type":"string","description":"Enumerates permission effects.","enum":["allow","deny"]},"hq_PermissionActionScalarOrList":{"description":"Is either a single action or a list of actions.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_PermissionResourceScalarOrList":{"description":"Is either a single string or a list of strings.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_UpdateRoleRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateRoleRequest":{"type":"object","description":"Updates a role. Absent fields are left untouched.","properties":{"display_name":{"type":"string","description":"Updates the display name of the role.","minLength":1,"maxLength":150},"description":{"type":"string","description":"Updates the description of the role.","maxLength":280},"policy":{"type":"array","description":"Sets, if specififed, the new permission statements.","items":{"$ref":"#/components/schemas/hq_PermissionStatement"}},"metadata":{"$ref":"#/components/schemas/hq_MetadataPatchRequest"}}},"hq_PermissionStatement":{"type":"object","description":"Describes the effect for an action and resource.","properties":{"effect":{"$ref":"#/components/schemas/hq_PermissionEffect"},"action":{"$ref":"#/components/schemas/hq_PermissionActionScalarOrList"},"resource":{"$ref":"#/components/schemas/hq_PermissionResourceScalarOrList"}},"required":["effect","action","resource"]},"hq_PermissionEffect":{"type":"string","description":"Enumerates permission effects.","enum":["allow","deny"]},"hq_PermissionActionScalarOrList":{"description":"Is either a single action or a list of actions.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_PermissionResourceScalarOrList":{"description":"Is either a single string or a list of strings.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_CompactRoleList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CompactRoleList":{"type":"object","description":"Contains a list of CompactRoles.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_CompactRole"}}},"required":["items"]},"hq_CompactRole":{"type":"object","description":"Represents a Role in a compact way.","properties":{"name":{"description":"Holds the unique name of this role.","type":"string"},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"description":{"type":"string","description":"Contains the description of the role."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"policy_length":{"description":"Is set to the number of PermissionStatements in the Policy.","type":"integer"},"metadata":{"$ref":"#/components/schemas/hq_Metadata"}},"required":["name","display_name","lrn","description","id","created_at","policy_length"]},"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_PermissionStatement object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionStatement":{"type":"object","description":"Describes the effect for an action and resource.","properties":{"effect":{"$ref":"#/components/schemas/hq_PermissionEffect"},"action":{"$ref":"#/components/schemas/hq_PermissionActionScalarOrList"},"resource":{"$ref":"#/components/schemas/hq_PermissionResourceScalarOrList"}},"required":["effect","action","resource"]},"hq_PermissionEffect":{"type":"string","description":"Enumerates permission effects.","enum":["allow","deny"]},"hq_PermissionActionScalarOrList":{"description":"Is either a single action or a list of actions.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]},"hq_PermissionResourceScalarOrList":{"description":"Is either a single string or a list of strings.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]}}}}
```

## The hq\_PermissionActionScalarOrList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionActionScalarOrList":{"description":"Is either a single action or a list of actions.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]}}}}
```

## The hq\_PermissionResourceScalarOrList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionResourceScalarOrList":{"description":"Is either a single string or a list of strings.","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}]}}}}
```

## The hq\_PermissionEffect object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionEffect":{"type":"string","description":"Enumerates permission effects.","enum":["allow","deny"]}}}}
```

## The hq\_RuntimeInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_RuntimeInfo":{"type":"object","description":"Contains backend run-time info: statistics along with build information.","properties":{"version":{"type":"string","description":"Is set to the HQ build version."},"build_id":{"type":"string","description":"Is set to the HQ build id."},"backend_build_id":{"type":"string","description":"Is set to the HQ backend build id."},"ui_build_id":{"type":"string","description":"Is set to the HQ UI build id."},"goos":{"type":"string","description":"Equals runtime.GOOS."},"goarch":{"type":"string","description":"Equals runtime.GOARCH."},"started_at":{"type":"string","format":"date-time","description":"Is set to the instant the backend started."},"memstats_alloc":{"type":"integer","format":"int64","description":"Equals runtime.Memstats.Alloc."},"memstats_sys":{"type":"integer","format":"int64","description":"Equals runtime.Memstats.Sys."},"gc_cpu_fraction":{"type":"number","description":"Equals runtime.Memstats.GCCPUFraction."},"num_goroutine":{"type":"integer","format":"int32","description":"Equals runtime.NumGoroutine()."}},"required":["version","build_id","backend_build_id","ui_build_id","goos","goarch","started_at","memstats_alloc","memstats_sys","gc_cpu_fraction","num_goroutine"]}}}}
```

## The hq\_Metadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Metadata":{"type":"object","description":"Allows attaching custom string key/values to resources.\nThe following maxima apply:\n- 50 keys/values;\n- 40 bytes key length;\n- 500 bytes value length.\n","additionalProperties":{"type":"string"}}}}}
```

## The hq\_MetadataPatchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_MetadataPatchRequest":{"type":"object","description":"Patches metadata. It has the following semantics:\n  - Absent keys are left untouched;\n  - Null values are deleted;\n  - Non-null values are replaced.\n","additionalProperties":{"type":"string","nullable":true}}}}}
```

## The hq\_Settings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Settings":{"type":"object","description":"Contains application settings.","properties":{"api":{"$ref":"#/components/schemas/hq_APIConfig"},"audit":{"$ref":"#/components/schemas/hq_AuditConfig"},"features":{"$ref":"#/components/schemas/hq_FeaturesConfig"}},"required":["api","audit","features"]},"hq_APIConfig":{"type":"object","properties":{"saml":{"$ref":"#/components/schemas/hq_SAMLConfig"},"oauth2":{"$ref":"#/components/schemas/hq_OAuth2Config"}},"required":["saml","oauth2"]},"hq_SAMLConfig":{"type":"object","description":"Contains SAML configuration settings.","properties":{"user_creation_mode":{"$ref":"#/components/schemas/hq_SSOUserCreationMode"},"users_group_membership_management_mode":{"$ref":"#/components/schemas/hq_SSOUsersGroupMembershipManagementMode"}},"required":["user_creation_mode","users_group_membership_management_mode"]},"hq_SSOUserCreationMode":{"type":"string","title":"Corresponds to user_creation_mode application config setting.","description":"user_creation_mode setting controls how the creation of users should be handled in relation to SSO information.\nWith the 'manual' mode, a user that exists externally in an Identity Provider will have to be manually created locally.\nWith the 'sso' mode, that process will be automatic and a matching user will be created if it doesn't exist locally.\n","enum":["manual","sso"]},"hq_SSOUsersGroupMembershipManagementMode":{"type":"string","title":"Corresponds to users_group_membership_management_mode application config setting.","description":"users_group_membership_management_mode setting controls how the management of a user's group membership should be handled in relation to SSO information.\nWith the 'manual' mode, the information about the group membership returned from an Identity Provider will not be used\nand a user will only be a member of groups that were explicitly assigned to him locally.\nWith the 'sso' mode, groups returned from Identity Provider will be used instead.\n","enum":["manual","sso"]},"hq_OAuth2Config":{"type":"object","description":"Contains OAuth2 configuration settings.","properties":{"authorization_server_enabled":{"type":"boolean","description":"Indicates if HQ's OAuth 2 authorization server is enabled."}},"required":["authorization_server_enabled"]},"hq_AuditConfig":{"type":"object","description":"Contains audit configuration settings.","properties":{"enabled":{"type":"boolean","description":"Enables or disables API audit logging.","default":false},"retention_period":{"type":"string","description":"The audit log retention period, in Go time.Duration format (e.g., \"720h\"\nfor 30 days). When absent, automatic deletion is disabled.\n"}},"required":["enabled"]},"hq_FeaturesConfig":{"type":"object","description":"Advertises which optional/experimental product features are enabled.","properties":{"consumer_groups":{"type":"boolean","description":"Whether the consumer groups feature is enabled.","default":false}},"required":["consumer_groups"]}}}}
```

## The hq\_FeaturesConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_FeaturesConfig":{"type":"object","description":"Advertises which optional/experimental product features are enabled.","properties":{"consumer_groups":{"type":"boolean","description":"Whether the consumer groups feature is enabled.","default":false}},"required":["consumer_groups"]}}}}
```

## The hq\_APIConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_APIConfig":{"type":"object","properties":{"saml":{"$ref":"#/components/schemas/hq_SAMLConfig"},"oauth2":{"$ref":"#/components/schemas/hq_OAuth2Config"}},"required":["saml","oauth2"]},"hq_SAMLConfig":{"type":"object","description":"Contains SAML configuration settings.","properties":{"user_creation_mode":{"$ref":"#/components/schemas/hq_SSOUserCreationMode"},"users_group_membership_management_mode":{"$ref":"#/components/schemas/hq_SSOUsersGroupMembershipManagementMode"}},"required":["user_creation_mode","users_group_membership_management_mode"]},"hq_SSOUserCreationMode":{"type":"string","title":"Corresponds to user_creation_mode application config setting.","description":"user_creation_mode setting controls how the creation of users should be handled in relation to SSO information.\nWith the 'manual' mode, a user that exists externally in an Identity Provider will have to be manually created locally.\nWith the 'sso' mode, that process will be automatic and a matching user will be created if it doesn't exist locally.\n","enum":["manual","sso"]},"hq_SSOUsersGroupMembershipManagementMode":{"type":"string","title":"Corresponds to users_group_membership_management_mode application config setting.","description":"users_group_membership_management_mode setting controls how the management of a user's group membership should be handled in relation to SSO information.\nWith the 'manual' mode, the information about the group membership returned from an Identity Provider will not be used\nand a user will only be a member of groups that were explicitly assigned to him locally.\nWith the 'sso' mode, groups returned from Identity Provider will be used instead.\n","enum":["manual","sso"]},"hq_OAuth2Config":{"type":"object","description":"Contains OAuth2 configuration settings.","properties":{"authorization_server_enabled":{"type":"boolean","description":"Indicates if HQ's OAuth 2 authorization server is enabled."}},"required":["authorization_server_enabled"]}}}}
```

## The hq\_SAMLConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SAMLConfig":{"type":"object","description":"Contains SAML configuration settings.","properties":{"user_creation_mode":{"$ref":"#/components/schemas/hq_SSOUserCreationMode"},"users_group_membership_management_mode":{"$ref":"#/components/schemas/hq_SSOUsersGroupMembershipManagementMode"}},"required":["user_creation_mode","users_group_membership_management_mode"]},"hq_SSOUserCreationMode":{"type":"string","title":"Corresponds to user_creation_mode application config setting.","description":"user_creation_mode setting controls how the creation of users should be handled in relation to SSO information.\nWith the 'manual' mode, a user that exists externally in an Identity Provider will have to be manually created locally.\nWith the 'sso' mode, that process will be automatic and a matching user will be created if it doesn't exist locally.\n","enum":["manual","sso"]},"hq_SSOUsersGroupMembershipManagementMode":{"type":"string","title":"Corresponds to users_group_membership_management_mode application config setting.","description":"users_group_membership_management_mode setting controls how the management of a user's group membership should be handled in relation to SSO information.\nWith the 'manual' mode, the information about the group membership returned from an Identity Provider will not be used\nand a user will only be a member of groups that were explicitly assigned to him locally.\nWith the 'sso' mode, groups returned from Identity Provider will be used instead.\n","enum":["manual","sso"]}}}}
```

## The hq\_SSOUserCreationMode object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SSOUserCreationMode":{"type":"string","title":"Corresponds to user_creation_mode application config setting.","description":"user_creation_mode setting controls how the creation of users should be handled in relation to SSO information.\nWith the 'manual' mode, a user that exists externally in an Identity Provider will have to be manually created locally.\nWith the 'sso' mode, that process will be automatic and a matching user will be created if it doesn't exist locally.\n","enum":["manual","sso"]}}}}
```

## The hq\_SSOUsersGroupMembershipManagementMode object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SSOUsersGroupMembershipManagementMode":{"type":"string","title":"Corresponds to users_group_membership_management_mode application config setting.","description":"users_group_membership_management_mode setting controls how the management of a user's group membership should be handled in relation to SSO information.\nWith the 'manual' mode, the information about the group membership returned from an Identity Provider will not be used\nand a user will only be a member of groups that were explicitly assigned to him locally.\nWith the 'sso' mode, groups returned from Identity Provider will be used instead.\n","enum":["manual","sso"]}}}}
```

## The hq\_OAuth2Config object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2Config":{"type":"object","description":"Contains OAuth2 configuration settings.","properties":{"authorization_server_enabled":{"type":"boolean","description":"Indicates if HQ's OAuth 2 authorization server is enabled."}},"required":["authorization_server_enabled"]}}}}
```

## The hq\_OAuth2AuthorizationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2AuthorizationRequest":{"type":"object","properties":{"client_id":{"type":"string"},"redirect_uri":{"type":"string"},"response_type":{"type":"string"},"scope":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"code_challenge":{"type":"string"},"code_challenge_method":{"type":"string"}},"required":["client_id","redirect_uri","response_type","scope","state"]}}}}
```

## The hq\_OAuth2AuthorizationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2AuthorizationResponse":{"type":"object","properties":{"redirect_uri":{"type":"string"}},"required":["redirect_uri"]}}}}
```

## The hq\_OAuth2AppProvenance object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2AppProvenance":{"type":"string","description":"Tells how the OAuth2 Application was registered.","enum":["dcr","api"]}}}}
```

## The hq\_OAuth2UserAuthorization object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2UserAuthorization":{"type":"object","properties":{"grant_id":{"type":"string","deprecated":true},"grant_issued_at":{"type":"string","format":"date-time","deprecated":true},"authorization_id":{"type":"string"},"authorization_issued_at":{"type":"string","format":"date-time"},"app_name":{"type":"string"},"app_display_name":{"type":"string"},"app_client_id":{"type":"string"},"app_provenance":{"$ref":"#/components/schemas/hq_OAuth2AppProvenance"},"scope":{"type":"array","items":{"type":"string"}},"last_activity_at":{"type":"string","format":"date-time"}},"required":["grant_id","grant_issued_at","authorization_id","authorization_issued_at","app_name","app_display_name","app_client_id","app_provenance","scope"]},"hq_OAuth2AppProvenance":{"type":"string","description":"Tells how the OAuth2 Application was registered.","enum":["dcr","api"]}}}}
```

## The hq\_OAuth2UserAuthorizationList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2UserAuthorizationList":{"type":"object","description":"Contains a list of OAuth2 user authorizations.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_OAuth2UserAuthorization"}}},"required":["items"]},"hq_OAuth2UserAuthorization":{"type":"object","properties":{"grant_id":{"type":"string","deprecated":true},"grant_issued_at":{"type":"string","format":"date-time","deprecated":true},"authorization_id":{"type":"string"},"authorization_issued_at":{"type":"string","format":"date-time"},"app_name":{"type":"string"},"app_display_name":{"type":"string"},"app_client_id":{"type":"string"},"app_provenance":{"$ref":"#/components/schemas/hq_OAuth2AppProvenance"},"scope":{"type":"array","items":{"type":"string"}},"last_activity_at":{"type":"string","format":"date-time"}},"required":["grant_id","grant_issued_at","authorization_id","authorization_issued_at","app_name","app_display_name","app_client_id","app_provenance","scope"]},"hq_OAuth2AppProvenance":{"type":"string","description":"Tells how the OAuth2 Application was registered.","enum":["dcr","api"]}}}}
```

## The hq\_AuditConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditConfig":{"type":"object","description":"Contains audit configuration settings.","properties":{"enabled":{"type":"boolean","description":"Enables or disables API audit logging.","default":false},"retention_period":{"type":"string","description":"The audit log retention period, in Go time.Duration format (e.g., \"720h\"\nfor 30 days). When absent, automatic deletion is disabled.\n"}},"required":["enabled"]}}}}
```

## The hq\_LoginRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LoginRequest":{"type":"object","description":"Bundles a username/password for authentication purposes.","properties":{"username":{"type":"string"},"password":{"type":"string","format":"password"},"redirection_token":{"type":"string"}},"required":["username","password"]}}}}
```

## The hq\_LoginResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LoginResponse":{"type":"object","description":"Contains the response for successful login.","properties":{"redir_to":{"type":"string","description":"Optionally contains a relative URL (path, query) where to redirect\nto. One application of this property is resuming an OAuth2\nauthorization flow.\n"}}}}}}
```

## The hq\_Licence object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Licence":{"type":"object","description":"Models a licence.","properties":{"id":{"description":"Unique identifier for this licence (hex string).","type":"string"},"expires_at":{"description":"Is set to the moment HQ no longer considers this licence valid. Is\nomitted for licences that do not expire.\n","format":"date-time","type":"string"},"tier":{"$ref":"#/components/schemas/hq_LicenceTier"},"features":{"$ref":"#/components/schemas/hq_LicenceFeatures"},"limits":{"$ref":"#/components/schemas/hq_LicenceLimits"},"limit_breach":{"$ref":"#/components/schemas/hq_LicenceLimitBreach"}},"required":["id","tier","features","limits"]},"hq_LicenceTier":{"type":"string","description":"Enumerates licence tiers.","enum":["community","enterprise"]},"hq_LicenceFeatures":{"type":"object","description":"Groups licence features as boolean flags.","properties":{"kafka_topic_backup_restore":{"description":"Whether Kafka topic backup and restore is enabled.","type":"boolean"},"single_sign_on":{"description":"Whether single sign-on is enabled.","type":"boolean"},"k2k":{"description":"Whether K2K (Kafka to Kafka) is enabled.","type":"boolean"},"k2k_exactly_once":{"description":"Whether K2K exactly-once semantics is enabled.","type":"boolean"},"k2k_bidirectional":{"description":"Whether K2K bidirectional replication is enabled.","type":"boolean"},"k2k_offsets_migration":{"description":"Whether K2K consumer offsets migration is enabled.","type":"boolean"},"k2k_schema_mapping":{"description":"Whether K2K schema mapping is enabled.","type":"boolean"}},"required":["kafka_topic_backup_restore","single_sign_on","k2k","k2k_exactly_once","k2k_bidirectional","k2k_offsets_migration","k2k_schema_mapping"]},"hq_LicenceLimits":{"type":"object","description":"Groups licence limits as integer values. If a field is missing or null, it means unlimited.","properties":{"iam_user":{"description":"Maximum number of IAM users allowed. If missing or null, unlimited.","type":"integer"},"iam_admin":{"description":"Maximum number of IAM admins allowed. If missing or null, unlimited.","type":"integer"},"iam_group":{"description":"Maximum number of IAM groups allowed. If missing or null, unlimited.","type":"integer"},"iam_role":{"description":"Maximum number of IAM roles allowed. If missing or null, unlimited.","type":"integer"},"k2k_apps":{"description":"Maximum number of K2K apps allowed. If missing or null, unlimited.","type":"integer"}},"required":[]},"hq_LicenceLimitBreach":{"type":"object","description":"Present only while persisted resource counts currently exceed the licence caps (for example after a downgrade or direct database tampering). The service will stop unless the breach is resolved before shuts_down_at.","properties":{"message":{"description":"Human-readable description of the breach, suitable for display.","type":"string"},"shuts_down_at":{"description":"The moment HQ will stop unless the breach is resolved.","format":"date-time","type":"string"}},"required":["message","shuts_down_at"]}}}}
```

## The hq\_LicenceFeatures object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LicenceFeatures":{"type":"object","description":"Groups licence features as boolean flags.","properties":{"kafka_topic_backup_restore":{"description":"Whether Kafka topic backup and restore is enabled.","type":"boolean"},"single_sign_on":{"description":"Whether single sign-on is enabled.","type":"boolean"},"k2k":{"description":"Whether K2K (Kafka to Kafka) is enabled.","type":"boolean"},"k2k_exactly_once":{"description":"Whether K2K exactly-once semantics is enabled.","type":"boolean"},"k2k_bidirectional":{"description":"Whether K2K bidirectional replication is enabled.","type":"boolean"},"k2k_offsets_migration":{"description":"Whether K2K consumer offsets migration is enabled.","type":"boolean"},"k2k_schema_mapping":{"description":"Whether K2K schema mapping is enabled.","type":"boolean"}},"required":["kafka_topic_backup_restore","single_sign_on","k2k","k2k_exactly_once","k2k_bidirectional","k2k_offsets_migration","k2k_schema_mapping"]}}}}
```

## The hq\_LicenceLimits object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LicenceLimits":{"type":"object","description":"Groups licence limits as integer values. If a field is missing or null, it means unlimited.","properties":{"iam_user":{"description":"Maximum number of IAM users allowed. If missing or null, unlimited.","type":"integer"},"iam_admin":{"description":"Maximum number of IAM admins allowed. If missing or null, unlimited.","type":"integer"},"iam_group":{"description":"Maximum number of IAM groups allowed. If missing or null, unlimited.","type":"integer"},"iam_role":{"description":"Maximum number of IAM roles allowed. If missing or null, unlimited.","type":"integer"},"k2k_apps":{"description":"Maximum number of K2K apps allowed. If missing or null, unlimited.","type":"integer"}},"required":[]}}}}
```

## The hq\_LicenceLimitBreach object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LicenceLimitBreach":{"type":"object","description":"Present only while persisted resource counts currently exceed the licence caps (for example after a downgrade or direct database tampering). The service will stop unless the breach is resolved before shuts_down_at.","properties":{"message":{"description":"Human-readable description of the breach, suitable for display.","type":"string"},"shuts_down_at":{"description":"The moment HQ will stop unless the breach is resolved.","format":"date-time","type":"string"}},"required":["message","shuts_down_at"]}}}}
```

## The hq\_LicenceSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LicenceSummary":{"type":"object","description":"Models a compact licence.","properties":{"is_community":{"type":"boolean","description":"Is true when the licence is a community one, false otherwise."}},"required":["is_community"]}}}}
```

## The hq\_LicenceTier object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_LicenceTier":{"type":"string","description":"Enumerates licence tiers.","enum":["community","enterprise"]}}}}
```

## The hq\_PermissionDefinitions object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionDefinitions":{"type":"object","description":"Contains definitions for entities in the permission model.","properties":{"resource_definitions":{"description":"Enumerates resource definitions.","type":"array","items":{"$ref":"#/components/schemas/hq_PermissionResourceDefinition"}}},"required":["resource_definitions"]},"hq_PermissionResourceDefinition":{"type":"object","description":"Defines for each resource its format and the actions that act on it.","properties":{"service":{"description":"Has the name of the service this resource belongs to. E.g., \"kafka\".","type":"string"},"short_name":{"description":"Contains the short resource name. E.g., \"topic\".","type":"string"},"full_name":{"description":"Contains the fully qualified resource name. E.g., \"kafka:topic\".","type":"string"},"resource_format":{"description":"Is set to the resource format. E.g., \"kafka:topic:${Environment}/kafka/${Topic}\"","type":"string"},"actions":{"type":"array","description":"Enumerates the actions that operate on this resource.","items":{"type":"string"}}},"required":["service","short_name","full_name","resource_format","actions"]}}}}
```

## The hq\_PermissionResourceDefinition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PermissionResourceDefinition":{"type":"object","description":"Defines for each resource its format and the actions that act on it.","properties":{"service":{"description":"Has the name of the service this resource belongs to. E.g., \"kafka\".","type":"string"},"short_name":{"description":"Contains the short resource name. E.g., \"topic\".","type":"string"},"full_name":{"description":"Contains the fully qualified resource name. E.g., \"kafka:topic\".","type":"string"},"resource_format":{"description":"Is set to the resource format. E.g., \"kafka:topic:${Environment}/kafka/${Topic}\"","type":"string"},"actions":{"type":"array","description":"Enumerates the actions that operate on this resource.","items":{"type":"string"}}},"required":["service","short_name","full_name","resource_format","actions"]}}}}
```

## The hq\_K2KAppMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppMetrics":{"type":"object","description":"Tracks metrics for a K2KApp.","properties":{"state":{"$ref":"#/components/schemas/hq_K2KAppMetricsState"},"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"error_message":{"type":"string","description":"Contains the error message if the state is \"error\"."},"source_topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourceTopic"}},"destination_topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationTopic"}},"errors":{"type":"array","items":{"type":"string"}},"stalled":{"type":"boolean","description":"Whether the pipeline is stalled and likely not progressing."},"stall_message":{"type":"string","description":"Contains the stall message if stalled is true."},"stale":{"type":"boolean","description":"True when any sub-field (source/destination offsets or throughput) carries a stale flag, i.e. at least one data source is being served from the HQ-side cache this tick. Use the per-topic stale fields on K2KSourceOffsets, K2KSourceThroughput, K2KDestinationOffsets, or K2KDestinationThroughput for the precise signal."}},"required":["topic_metrics","updated_at","state","error_message","source_topics","destination_topics","errors","stalled"]},"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]},"hq_K2KSourceTopic":{"type":"object","description":"Tracks metrics for K2K source topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KSourceThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KSourceOffsets"}},"required":["lrn","name"]},"hq_K2KSourceThroughput":{"type":"object","description":"Aggregates throughput metrics for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KSourceOffsets":{"type":"object","description":"Aggregates offsets data for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the source-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO, lag) is served from the HQ-side cache rather than collected live from the source cluster this tick. Indicates the data may not reflect the current broker state."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourcePartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KSourcePartitionOffsets":{"type":"object","description":"Groups offsets and lag per source partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of the source topic partition."},"consumer_offset":{"type":"integer","format":"int64","description":"The last offset committed by the K2K consumer on this partition, as stored in K2K's internal control topic (not Kafka's standard __consumer_offsets topic). Absent until the consumer has committed at least once."},"lag":{"type":"integer","format":"int64","description":"Difference between log_end_offset and consumer_offset. Absent when consumer_offset is not yet available."},"truncated":{"type":"boolean","description":"Whether this partition's source topic log was truncated since the previous HQ tick (e.g. broker restart with RF=1)."}},"required":["partition","log_end_offset","truncated"]},"hq_K2KDestinationTopic":{"type":"object","description":"Tracks metrics for K2K destination topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KDestinationThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KDestinationOffsets"}},"required":["lrn","name"]},"hq_K2KDestinationThroughput":{"type":"object","description":"Aggregates throughput metrics for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KDestinationOffsets":{"type":"object","description":"Aggregates offsets and lag data for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the target-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO) is served from the HQ-side cache rather than collected live from the target cluster this tick."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationPartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KDestinationPartitionOffsets":{"type":"object","description":"Groups offsets and lag data per destination partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of this partition on the destination Kafka cluster. Represents the actual broker LEO, not the replicated position. Absent when the topic does not yet exist on the destination cluster."},"lag":{"type":"integer","format":"int64","description":"Deprecated: lag is now reported on the source partition. Populated only for 1:1 replication where source and destination share the same topic name and partition layout; absent for repartitioned or renamed topologies.","deprecated":true}},"required":["partition","log_end_offset"]}}}}
```

## The hq\_K2KSourceTopic object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSourceTopic":{"type":"object","description":"Tracks metrics for K2K source topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KSourceThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KSourceOffsets"}},"required":["lrn","name"]},"hq_K2KSourceThroughput":{"type":"object","description":"Aggregates throughput metrics for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KSourceOffsets":{"type":"object","description":"Aggregates offsets data for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the source-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO, lag) is served from the HQ-side cache rather than collected live from the source cluster this tick. Indicates the data may not reflect the current broker state."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourcePartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KSourcePartitionOffsets":{"type":"object","description":"Groups offsets and lag per source partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of the source topic partition."},"consumer_offset":{"type":"integer","format":"int64","description":"The last offset committed by the K2K consumer on this partition, as stored in K2K's internal control topic (not Kafka's standard __consumer_offsets topic). Absent until the consumer has committed at least once."},"lag":{"type":"integer","format":"int64","description":"Difference between log_end_offset and consumer_offset. Absent when consumer_offset is not yet available."},"truncated":{"type":"boolean","description":"Whether this partition's source topic log was truncated since the previous HQ tick (e.g. broker restart with RF=1)."}},"required":["partition","log_end_offset","truncated"]}}}}
```

## The hq\_K2KDestinationTopic object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KDestinationTopic":{"type":"object","description":"Tracks metrics for K2K destination topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KDestinationThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KDestinationOffsets"}},"required":["lrn","name"]},"hq_K2KDestinationThroughput":{"type":"object","description":"Aggregates throughput metrics for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KDestinationOffsets":{"type":"object","description":"Aggregates offsets and lag data for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the target-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO) is served from the HQ-side cache rather than collected live from the target cluster this tick."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationPartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KDestinationPartitionOffsets":{"type":"object","description":"Groups offsets and lag data per destination partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of this partition on the destination Kafka cluster. Represents the actual broker LEO, not the replicated position. Absent when the topic does not yet exist on the destination cluster."},"lag":{"type":"integer","format":"int64","description":"Deprecated: lag is now reported on the source partition. Populated only for 1:1 replication where source and destination share the same topic name and partition layout; absent for repartitioned or renamed topologies.","deprecated":true}},"required":["partition","log_end_offset"]}}}}
```

## The hq\_K2KSourceThroughput object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSourceThroughput":{"type":"object","description":"Aggregates throughput metrics for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]}}}}
```

## The hq\_K2KDestinationThroughput object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KDestinationThroughput":{"type":"object","description":"Aggregates throughput metrics for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]}}}}
```

## The hq\_K2KSourceOffsets object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSourceOffsets":{"type":"object","description":"Aggregates offsets data for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the source-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO, lag) is served from the HQ-side cache rather than collected live from the source cluster this tick. Indicates the data may not reflect the current broker state."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourcePartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KSourcePartitionOffsets":{"type":"object","description":"Groups offsets and lag per source partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of the source topic partition."},"consumer_offset":{"type":"integer","format":"int64","description":"The last offset committed by the K2K consumer on this partition, as stored in K2K's internal control topic (not Kafka's standard __consumer_offsets topic). Absent until the consumer has committed at least once."},"lag":{"type":"integer","format":"int64","description":"Difference between log_end_offset and consumer_offset. Absent when consumer_offset is not yet available."},"truncated":{"type":"boolean","description":"Whether this partition's source topic log was truncated since the previous HQ tick (e.g. broker restart with RF=1)."}},"required":["partition","log_end_offset","truncated"]}}}}
```

## The hq\_K2KDestinationOffsets object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KDestinationOffsets":{"type":"object","description":"Aggregates offsets and lag data for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the target-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO) is served from the HQ-side cache rather than collected live from the target cluster this tick."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationPartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KDestinationPartitionOffsets":{"type":"object","description":"Groups offsets and lag data per destination partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of this partition on the destination Kafka cluster. Represents the actual broker LEO, not the replicated position. Absent when the topic does not yet exist on the destination cluster."},"lag":{"type":"integer","format":"int64","description":"Deprecated: lag is now reported on the source partition. Populated only for 1:1 replication where source and destination share the same topic name and partition layout; absent for repartitioned or renamed topologies.","deprecated":true}},"required":["partition","log_end_offset"]}}}}
```

## The hq\_K2KSourcePartitionOffsets object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSourcePartitionOffsets":{"type":"object","description":"Groups offsets and lag per source partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of the source topic partition."},"consumer_offset":{"type":"integer","format":"int64","description":"The last offset committed by the K2K consumer on this partition, as stored in K2K's internal control topic (not Kafka's standard __consumer_offsets topic). Absent until the consumer has committed at least once."},"lag":{"type":"integer","format":"int64","description":"Difference between log_end_offset and consumer_offset. Absent when consumer_offset is not yet available."},"truncated":{"type":"boolean","description":"Whether this partition's source topic log was truncated since the previous HQ tick (e.g. broker restart with RF=1)."}},"required":["partition","log_end_offset","truncated"]}}}}
```

## The hq\_K2KDestinationPartitionOffsets object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KDestinationPartitionOffsets":{"type":"object","description":"Groups offsets and lag data per destination partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of this partition on the destination Kafka cluster. Represents the actual broker LEO, not the replicated position. Absent when the topic does not yet exist on the destination cluster."},"lag":{"type":"integer","format":"int64","description":"Deprecated: lag is now reported on the source partition. Populated only for 1:1 replication where source and destination share the same topic name and partition layout; absent for repartitioned or renamed topologies.","deprecated":true}},"required":["partition","log_end_offset"]}}}}
```

## The hq\_K2KAppMetricsSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppMetricsSummary":{"type":"object","description":"Tracks metrics for a K2KApp.","properties":{"topics_count":{"type":"integer","description":"Contains the number of topics."},"partitions_count":{"type":"integer","description":"Contains the number of partitions."},"total_bytes_per_second_read":{"type":"number","format":"double","description":"Total bytes per second read across all topics."},"total_bytes_per_second_written":{"type":"number","format":"double","description":"Total bytes per second written across all topics."},"total_records_per_second_read":{"type":"number","format":"double","description":"Total records per second read across all topics."},"total_records_per_second_written":{"type":"number","format":"double","description":"Total records per second written across all topics."},"state":{"$ref":"#/components/schemas/hq_K2KAppMetricsState"},"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"error_message":{"type":"string","description":"Contains the error message if the state is \"error\"."}},"required":["topics_count","partitions_count","total_bytes_per_second_read","total_bytes_per_second_written","total_records_per_second_read","total_records_per_second_written","updated_at","state","error_message"]},"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]}}}}
```

## The hq\_BaseManifestMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]}}}}
```

## The hq\_BaseManifest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]}}}}
```

## The hq\_K2KAppWithOptionalMetricsSummaryList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppWithOptionalMetricsSummaryList":{"type":"object","description":"Contains K2KApps (Kafka-to-Kafka applications).","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KAppWithOptionalMetricsSummary"}}},"required":["items"]},"hq_K2KAppWithOptionalMetricsSummary":{"description":"Extends a K2KApp (Kafka-to-Kafka application) with an optional metrics summary.","allOf":[{"$ref":"#/components/schemas/hq_K2KApp"},{"type":"object","properties":{"metrics_summary":{"$ref":"#/components/schemas/hq_K2KAppMetricsSummary"}}}]},"hq_K2KApp":{"description":"Defines a K2KApp (Kafka-to-Kafka application).","allOf":[{"$ref":"#/components/schemas/hq_BaseManifest"},{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/hq_K2KAppSpec"},"status":{"$ref":"#/components/schemas/hq_K2KAppStatus"}},"required":["spec"]}]},"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]},"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."},"hq_K2KAppStatus":{"type":"object","description":"Contains the most recently observed status of a K2KApp. Read-only for clients.","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Contains the time instant this object was updated."},"state":{"$ref":"#/components/schemas/hq_K2KAppState"},"statusLastTransitionAt":{"type":"string","format":"date-time","description":"Contains the time instant the status was changed."},"statusMessage":{"type":"string","description":"Is a human-readable message indicating details about last the transition."},"observedGeneration":{"type":"integer","description":"Reflects the generation of the spec that this status corresponds to."},"deployment":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatus"},"kafka":{"$ref":"#/components/schemas/hq_K2KAppKafkaStatus"}},"required":["updatedAt","state","statusLastTransitionAt","statusMessage","observedGeneration","deployment","kafka"]},"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]},"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}},"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]},"hq_K2KAppMetricsSummary":{"type":"object","description":"Tracks metrics for a K2KApp.","properties":{"topics_count":{"type":"integer","description":"Contains the number of topics."},"partitions_count":{"type":"integer","description":"Contains the number of partitions."},"total_bytes_per_second_read":{"type":"number","format":"double","description":"Total bytes per second read across all topics."},"total_bytes_per_second_written":{"type":"number","format":"double","description":"Total bytes per second written across all topics."},"total_records_per_second_read":{"type":"number","format":"double","description":"Total records per second read across all topics."},"total_records_per_second_written":{"type":"number","format":"double","description":"Total records per second written across all topics."},"state":{"$ref":"#/components/schemas/hq_K2KAppMetricsState"},"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"error_message":{"type":"string","description":"Contains the error message if the state is \"error\"."}},"required":["topics_count","partitions_count","total_bytes_per_second_read","total_bytes_per_second_written","total_records_per_second_read","total_records_per_second_written","updated_at","state","error_message"]},"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]}}}}
```

## The hq\_K2KAppWithOptionalMetricsSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppWithOptionalMetricsSummary":{"description":"Extends a K2KApp (Kafka-to-Kafka application) with an optional metrics summary.","allOf":[{"$ref":"#/components/schemas/hq_K2KApp"},{"type":"object","properties":{"metrics_summary":{"$ref":"#/components/schemas/hq_K2KAppMetricsSummary"}}}]},"hq_K2KApp":{"description":"Defines a K2KApp (Kafka-to-Kafka application).","allOf":[{"$ref":"#/components/schemas/hq_BaseManifest"},{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/hq_K2KAppSpec"},"status":{"$ref":"#/components/schemas/hq_K2KAppStatus"}},"required":["spec"]}]},"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]},"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."},"hq_K2KAppStatus":{"type":"object","description":"Contains the most recently observed status of a K2KApp. Read-only for clients.","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Contains the time instant this object was updated."},"state":{"$ref":"#/components/schemas/hq_K2KAppState"},"statusLastTransitionAt":{"type":"string","format":"date-time","description":"Contains the time instant the status was changed."},"statusMessage":{"type":"string","description":"Is a human-readable message indicating details about last the transition."},"observedGeneration":{"type":"integer","description":"Reflects the generation of the spec that this status corresponds to."},"deployment":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatus"},"kafka":{"$ref":"#/components/schemas/hq_K2KAppKafkaStatus"}},"required":["updatedAt","state","statusLastTransitionAt","statusMessage","observedGeneration","deployment","kafka"]},"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]},"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}},"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]},"hq_K2KAppMetricsSummary":{"type":"object","description":"Tracks metrics for a K2KApp.","properties":{"topics_count":{"type":"integer","description":"Contains the number of topics."},"partitions_count":{"type":"integer","description":"Contains the number of partitions."},"total_bytes_per_second_read":{"type":"number","format":"double","description":"Total bytes per second read across all topics."},"total_bytes_per_second_written":{"type":"number","format":"double","description":"Total bytes per second written across all topics."},"total_records_per_second_read":{"type":"number","format":"double","description":"Total records per second read across all topics."},"total_records_per_second_written":{"type":"number","format":"double","description":"Total records per second written across all topics."},"state":{"$ref":"#/components/schemas/hq_K2KAppMetricsState"},"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"error_message":{"type":"string","description":"Contains the error message if the state is \"error\"."}},"required":["topics_count","partitions_count","total_bytes_per_second_read","total_bytes_per_second_written","total_records_per_second_read","total_records_per_second_written","updated_at","state","error_message"]},"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]}}}}
```

## The hq\_K2KAppWithOptionalMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppWithOptionalMetrics":{"description":"Extends a K2KApp with additional metrics, if available.","allOf":[{"$ref":"#/components/schemas/hq_K2KApp"},{"type":"object","properties":{"metrics":{"$ref":"#/components/schemas/hq_K2KAppMetrics"}}}]},"hq_K2KApp":{"description":"Defines a K2KApp (Kafka-to-Kafka application).","allOf":[{"$ref":"#/components/schemas/hq_BaseManifest"},{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/hq_K2KAppSpec"},"status":{"$ref":"#/components/schemas/hq_K2KAppStatus"}},"required":["spec"]}]},"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]},"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."},"hq_K2KAppStatus":{"type":"object","description":"Contains the most recently observed status of a K2KApp. Read-only for clients.","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Contains the time instant this object was updated."},"state":{"$ref":"#/components/schemas/hq_K2KAppState"},"statusLastTransitionAt":{"type":"string","format":"date-time","description":"Contains the time instant the status was changed."},"statusMessage":{"type":"string","description":"Is a human-readable message indicating details about last the transition."},"observedGeneration":{"type":"integer","description":"Reflects the generation of the spec that this status corresponds to."},"deployment":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatus"},"kafka":{"$ref":"#/components/schemas/hq_K2KAppKafkaStatus"}},"required":["updatedAt","state","statusLastTransitionAt","statusMessage","observedGeneration","deployment","kafka"]},"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]},"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}},"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]},"hq_K2KAppMetrics":{"type":"object","description":"Tracks metrics for a K2KApp.","properties":{"state":{"$ref":"#/components/schemas/hq_K2KAppMetricsState"},"updated_at":{"format":"date-time","type":"string","description":"Contains the time instant this object as a whole was updated."},"error_message":{"type":"string","description":"Contains the error message if the state is \"error\"."},"source_topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourceTopic"}},"destination_topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationTopic"}},"errors":{"type":"array","items":{"type":"string"}},"stalled":{"type":"boolean","description":"Whether the pipeline is stalled and likely not progressing."},"stall_message":{"type":"string","description":"Contains the stall message if stalled is true."},"stale":{"type":"boolean","description":"True when any sub-field (source/destination offsets or throughput) carries a stale flag, i.e. at least one data source is being served from the HQ-side cache this tick. Use the per-topic stale fields on K2KSourceOffsets, K2KSourceThroughput, K2KDestinationOffsets, or K2KDestinationThroughput for the precise signal."}},"required":["topic_metrics","updated_at","state","error_message","source_topics","destination_topics","errors","stalled"]},"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]},"hq_K2KSourceTopic":{"type":"object","description":"Tracks metrics for K2K source topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KSourceThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KSourceOffsets"}},"required":["lrn","name"]},"hq_K2KSourceThroughput":{"type":"object","description":"Aggregates throughput metrics for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KSourceOffsets":{"type":"object","description":"Aggregates offsets data for a source topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the source-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO, lag) is served from the HQ-side cache rather than collected live from the source cluster this tick. Indicates the data may not reflect the current broker state."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KSourcePartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KSourcePartitionOffsets":{"type":"object","description":"Groups offsets and lag per source partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of the source topic partition."},"consumer_offset":{"type":"integer","format":"int64","description":"The last offset committed by the K2K consumer on this partition, as stored in K2K's internal control topic (not Kafka's standard __consumer_offsets topic). Absent until the consumer has committed at least once."},"lag":{"type":"integer","format":"int64","description":"Difference between log_end_offset and consumer_offset. Absent when consumer_offset is not yet available."},"truncated":{"type":"boolean","description":"Whether this partition's source topic log was truncated since the previous HQ tick (e.g. broker restart with RF=1)."}},"required":["partition","log_end_offset","truncated"]},"hq_K2KDestinationTopic":{"type":"object","description":"Tracks metrics for K2K destination topics.","properties":{"lrn":{"type":"string"},"name":{"type":"string"},"throughput":{"$ref":"#/components/schemas/hq_K2KDestinationThroughput"},"offsets":{"$ref":"#/components/schemas/hq_K2KDestinationOffsets"}},"required":["lrn","name"]},"hq_K2KDestinationThroughput":{"type":"object","description":"Aggregates throughput metrics for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful GetK2KAppMetrics response from the agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when throughput data is served from the HQ-side cache rather than collected live this tick."},"bytes_per_second":{"type":"number","format":"double"},"records_per_second":{"type":"number","format":"double"}},"required":["last_retrieved_at","updated_at","bytes_per_second","records_per_second"]},"hq_K2KDestinationOffsets":{"type":"object","description":"Aggregates offsets and lag data for a destination topic.","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful ListTopics response from the target-env agent. Not advanced when serving from cache (stale=true)."},"updated_at":{"type":"string","format":"date-time","deprecated":true,"description":"Deprecated. Use last_retrieved_at."},"stale":{"type":"boolean","description":"True when partition data (LEO) is served from the HQ-side cache rather than collected live from the target cluster this tick."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KDestinationPartitionOffsets"}}},"required":["last_retrieved_at","updated_at","partitions"]},"hq_K2KDestinationPartitionOffsets":{"type":"object","description":"Groups offsets and lag data per destination partition.","properties":{"partition":{"type":"integer","format":"int64"},"log_end_offset":{"type":"integer","format":"int64","description":"The log end offset of this partition on the destination Kafka cluster. Represents the actual broker LEO, not the replicated position. Absent when the topic does not yet exist on the destination cluster."},"lag":{"type":"integer","format":"int64","description":"Deprecated: lag is now reported on the source partition. Populated only for 1:1 replication where source and destination share the same topic name and partition layout; absent for repartitioned or renamed topologies.","deprecated":true}},"required":["partition","log_end_offset"]}}}}
```

## The hq\_K2KApp object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KApp":{"description":"Defines a K2KApp (Kafka-to-Kafka application).","allOf":[{"$ref":"#/components/schemas/hq_BaseManifest"},{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/hq_K2KAppSpec"},"status":{"$ref":"#/components/schemas/hq_K2KAppStatus"}},"required":["spec"]}]},"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]},"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."},"hq_K2KAppStatus":{"type":"object","description":"Contains the most recently observed status of a K2KApp. Read-only for clients.","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Contains the time instant this object was updated."},"state":{"$ref":"#/components/schemas/hq_K2KAppState"},"statusLastTransitionAt":{"type":"string","format":"date-time","description":"Contains the time instant the status was changed."},"statusMessage":{"type":"string","description":"Is a human-readable message indicating details about last the transition."},"observedGeneration":{"type":"integer","description":"Reflects the generation of the spec that this status corresponds to."},"deployment":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatus"},"kafka":{"$ref":"#/components/schemas/hq_K2KAppKafkaStatus"}},"required":["updatedAt","state","statusLastTransitionAt","statusMessage","observedGeneration","deployment","kafka"]},"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]},"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}},"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]}}}}
```

## The hq\_K2KUpdateOffsetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KUpdateOffsetsRequest":{"type":"object","description":"Request to set consumer group offsets. At least one offset must be provided via either 'positions' (preferred) or 'offsets' (deprecated).","properties":{"positions":{"type":"object","description":"Map of topic names to partition offsets (preferred format). Key: Topic name (e.g., \"source-events\"). Value: Array of partition-offset pairs.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KPartitionOffset"}}},"offsets":{"type":"array","deprecated":true,"description":"DEPRECATED: Use positions field instead. Flat array of topic-partition-offset tuples.","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"}}}},"hq_K2KPartitionOffset":{"type":"object","description":"A partition-offset pair for the positions map format.","properties":{"partition":{"type":"integer","format":"int32","description":"The partition number.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set.","minimum":0}},"required":["partition","offset"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KPartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KPartitionOffset":{"type":"object","description":"A partition-offset pair for the positions map format.","properties":{"partition":{"type":"integer","format":"int32","description":"The partition number.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KUpdateOffsetsByTimestampRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KUpdateOffsetsByTimestampRequest":{"type":"object","description":"Request to set consumer group offsets by timestamp. At least one topic with partitions must be provided. A single timestamp applies to all specified partitions.","properties":{"timestamp":{"type":"string","format":"date-time","description":"The target timestamp (RFC3339 format). All specified partitions will be set to the first message at or after this timestamp."},"partitions":{"type":"object","description":"Map of topic names to partition numbers. Key: Topic name (e.g., \"source-events\"). Value: Array of partition numbers to reset.","minProperties":1,"additionalProperties":{"type":"array","items":{"type":"integer","format":"int32","minimum":0}}}},"required":["timestamp","partitions"]}}}}
```

## The hq\_K2KUpdateOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KUpdateOffsetsResponse":{"type":"object","properties":{"application_name":{"type":"string"},"updated_partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"},"description":"List of partitions and their updated offsets."}},"required":["application_name","updated_partitions"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KTopicPartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KConsumerGroupOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KConsumerGroupOffsetsResponse":{"type":"object","description":"Consumer group offset information for a K2K application.","properties":{"application_name":{"type":"string","description":"The name of the K2K application."},"consumer_group":{"type":"string","description":"The Kafka consumer group ID used by this application."},"topics":{"type":"array","description":"List of topics with their partition offsets (paginated).","items":{"$ref":"#/components/schemas/hq_K2KConsumerGroupTopicOffsets"}},"total_count":{"type":"integer","description":"Total number of topics across all pages."},"has_more":{"type":"boolean","description":"Whether more results exist beyond this page."},"next_cursor":{"type":"string","description":"Cursor for retrieving the next page of results.\nNull if this is the last page.\n","nullable":true}},"required":["application_name","consumer_group","topics","total_count","has_more"]},"hq_K2KConsumerGroupTopicOffsets":{"type":"object","description":"Offset information for a single topic.","properties":{"topic_name":{"type":"string","description":"The name of the Kafka topic."},"partitions":{"type":"array","description":"List of partition offsets for this topic.","items":{"$ref":"#/components/schemas/hq_K2KConsumerGroupPartitionOffset"}}},"required":["topic_name","partitions"]},"hq_K2KConsumerGroupPartitionOffset":{"type":"object","description":"Offset information for a single partition.","properties":{"partition":{"type":"integer","format":"int32","description":"The partition number.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The committed offset for this partition."}},"required":["partition","offset"]}}}}
```

## The hq\_K2KConsumerGroupTopicOffsets object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KConsumerGroupTopicOffsets":{"type":"object","description":"Offset information for a single topic.","properties":{"topic_name":{"type":"string","description":"The name of the Kafka topic."},"partitions":{"type":"array","description":"List of partition offsets for this topic.","items":{"$ref":"#/components/schemas/hq_K2KConsumerGroupPartitionOffset"}}},"required":["topic_name","partitions"]},"hq_K2KConsumerGroupPartitionOffset":{"type":"object","description":"Offset information for a single partition.","properties":{"partition":{"type":"integer","format":"int32","description":"The partition number.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The committed offset for this partition."}},"required":["partition","offset"]}}}}
```

## The hq\_K2KConsumerGroupPartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KConsumerGroupPartitionOffset":{"type":"object","description":"Offset information for a single partition.","properties":{"partition":{"type":"integer","format":"int32","description":"The partition number.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The committed offset for this partition."}},"required":["partition","offset"]}}}}
```

## The hq\_K2KUpdateOffsetsByTimestampResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KUpdateOffsetsByTimestampResponse":{"type":"object","description":"Response after setting offsets by timestamp.","properties":{"application_name":{"type":"string","description":"The name of the K2K application."},"timestamp":{"type":"string","format":"date-time","description":"The timestamp that was used for resolution."},"updated_partitions":{"type":"array","description":"List of partitions that were updated with resolved offsets.","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"}},"skipped_partitions":{"type":"array","description":"List of partitions that were skipped because the timestamp\nwas after the latest message (no offset available).\n","items":{"$ref":"#/components/schemas/hq_K2KSkippedPartition"}}},"required":["application_name","timestamp","updated_partitions"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]},"hq_K2KSkippedPartition":{"type":"object","description":"A partition that was skipped during timestamp resolution.","properties":{"topic":{"type":"string","description":"The topic name."},"partition":{"type":"integer","format":"int32","description":"The partition number."},"reason":{"$ref":"#/components/schemas/hq_K2KSkippedPartitionReason"}},"required":["topic","partition","reason"]},"hq_K2KSkippedPartitionReason":{"type":"string","description":"Why a partition was skipped during timestamp resolution.\n- no_offset_for_timestamp: The timestamp could not be resolved to an offset. This occurs when the timestamp is after the latest message or the partition is empty.\n- invalid_offset_from_agent: The agent returned an invalid (negative) offset, typically a Kafka sentinel value like -1.\n","enum":["no_offset_for_timestamp","invalid_offset_from_agent"]}}}}
```

## The hq\_K2KSkippedPartitionReason object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSkippedPartitionReason":{"type":"string","description":"Why a partition was skipped during timestamp resolution.\n- no_offset_for_timestamp: The timestamp could not be resolved to an offset. This occurs when the timestamp is after the latest message or the partition is empty.\n- invalid_offset_from_agent: The agent returned an invalid (negative) offset, typically a Kafka sentinel value like -1.\n","enum":["no_offset_for_timestamp","invalid_offset_from_agent"]}}}}
```

## The hq\_K2KSkippedPartition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KSkippedPartition":{"type":"object","description":"A partition that was skipped during timestamp resolution.","properties":{"topic":{"type":"string","description":"The topic name."},"partition":{"type":"integer","format":"int32","description":"The partition number."},"reason":{"$ref":"#/components/schemas/hq_K2KSkippedPartitionReason"}},"required":["topic","partition","reason"]},"hq_K2KSkippedPartitionReason":{"type":"string","description":"Why a partition was skipped during timestamp resolution.\n- no_offset_for_timestamp: The timestamp could not be resolved to an offset. This occurs when the timestamp is after the latest message or the partition is empty.\n- invalid_offset_from_agent: The agent returned an invalid (negative) offset, typically a Kafka sentinel value like -1.\n","enum":["no_offset_for_timestamp","invalid_offset_from_agent"]}}}}
```

## The hq\_K2KAppWithoutStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppWithoutStatus":{"description":"Defines a K2KApp (Kafka-to-Kafka application).","allOf":[{"$ref":"#/components/schemas/hq_BaseManifest"},{"type":"object","properties":{"spec":{"$ref":"#/components/schemas/hq_K2KAppSpec"}},"required":["spec"]}]},"hq_BaseManifest":{"type":"object","description":"Contains common fields shared by HQ manifests.","properties":{"apiVersion":{"type":"string","minLength":1},"kind":{"type":"string","minLength":1},"metadata":{"$ref":"#/components/schemas/hq_BaseManifestMetadata"}},"required":["apiVersion","kind","metadata"]},"hq_BaseManifestMetadata":{"type":"object","description":"Contains the metadata for a BaseManifest.","properties":{"name":{"type":"string","format":"hq-resource-name"},"displayName":{"type":"string","maxLength":150},"description":{"type":"string","description":"Has the description of the object.","maxLength":280},"id":{"type":"string","description":"Is a unique, read-only identifier.","readOnly":true},"lrn":{"type":"string","description":"Holds the LRN. Read-only.","readOnly":true},"creationTimestamp":{"type":"string","format":"date-time","description":"Is set to the time instant of creation. Read-only.","readOnly":true},"generation":{"type":"integer","description":"Is increased everytime the spec is updated. Read-only.","readOnly":true}},"required":["name"]},"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."}}}}
```

## The hq\_K2KAppSpec object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppSpec":{"type":"object","description":"Specifies a K2KApp (Kafka-to-Kafka application).","properties":{"sourceKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the source KafkaConnection LRN to read from."},"targetKafkaLRN":{"type":"string","format":"environments-kafka-connection-lrn","description":"Sets the target KafkaConnection LRN to write to."},"topics":{"type":"array","description":"Sets the topic(s) to replicate.","minItems":1,"items":{"type":"string","format":"kafka-topic","minLength":1}},"deploymentNamespaceLRN":{"type":"string","format":"kubernetes-namespace-lrn","description":"Defines the Kubernetes namespace to deploy to."},"replicas":{"type":"integer"},"kubernetes":{"$ref":"#/components/schemas/hq_K8sDeploymentOverrides"},"replicator":{"$ref":"#/components/schemas/hq_K2KReplicatorSettings"},"targetTopicMapping":{"$ref":"#/components/schemas/hq_K2KTargetTopicMapping"},"paused":{"type":"boolean","description":"Halts replication by scaling down to zero pods."},"configOverrides":{"$ref":"#/components/schemas/hq_K2KConfigOverrides"},"startFrom":{"$ref":"#/components/schemas/hq_K2KAppStartFrom"}},"required":["sourceKafkaLRN","targetKafkaLRN","deploymentNamespaceLRN","topics"]},"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}},"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]},"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]},"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}},"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."}}}}
```

## The hq\_K2KTargetTopicMapping object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTargetTopicMapping":{"description":"Controls how source environment topics are mapped to target environment topics.","oneOf":[{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingRename"},{"$ref":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}],"discriminator":{"propertyName":"type","mapping":{"sourceTopicName":"#/components/schemas/hq_K2KTargetTopicMappingSourceTopicName","prefixSuffix":"#/components/schemas/hq_K2KTargetTopicMappingPrefixSuffix","rename":"#/components/schemas/hq_K2KTargetTopicMappingRename","patternRouting":"#/components/schemas/hq_K2KTargetTopicMappingPatternRouting"}}},"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]},"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}},"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]},"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]}}}}
```

## The hq\_K2KTargetTopicMappingSourceTopicName object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTargetTopicMappingSourceTopicName":{"type":"object","description":"Preserves source topic names (1-to-1 mapping).","required":[]}}}}
```

## The hq\_K2KTargetTopicMappingPrefixSuffix object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTargetTopicMappingPrefixSuffix":{"type":"object","description":"Modifies target topic names by adding a prefix and/or suffix.","anyOf":[{"required":["prefix"]},{"required":["suffix"]}],"properties":{"prefix":{"type":"string","description":"Prefix to prepend to the target topic name.","minLength":1,"format":"kafka-topic-chars"},"suffix":{"type":"string","description":"Suffix to append to the target topic name.","minLength":1,"format":"kafka-topic-chars"}}}}}}
```

## The hq\_K2KTargetTopicMappingRename object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTargetTopicMappingRename":{"type":"object","description":"Renames topics using explicit source-to-target pairs. Use for simple renames that don't fit the prefixSuffix pattern.","properties":{"topics":{"type":"object","description":"A map of source topic names to target topic names.","additionalProperties":{"type":"string","format":"kafka-topic"}}},"required":["topics"]}}}}
```

## The hq\_K2KTargetTopicMappingPatternRouting object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTargetTopicMappingPatternRouting":{"type":"object","description":"Routes topics to targets using ordered regex pattern matching rules. The first matching rule wins.","properties":{"rules":{"type":"array","description":"Ordered list of pattern-to-topic mapping rules.","minItems":1,"items":{"$ref":"#/components/schemas/hq_K2KPatternRoutingRule"}}},"required":["rules"]},"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]}}}}
```

## The hq\_K2KPatternRoutingRule object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KPatternRoutingRule":{"type":"object","description":"A single regex pattern-to-topic routing rule.","properties":{"pattern":{"type":"string","description":"Regex pattern to match source topic names.","minLength":1},"topic":{"type":"string","format":"kafka-topic","description":"Target topic name for matched source topics."}},"required":["pattern","topic"]}}}}
```

## The hq\_K2KConfigOverrides object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KConfigOverrides":{"type":"object","description":"Contains arbitrary data that gets merged into the replicator's config.","additionalProperties":{}}}}}
```

## The hq\_K2KAppStartFrom object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppStartFrom":{"type":"string","description":"Replication start position. Accepts \"earliest\", \"latest\", or RFC3339 timestamp (e.g., \"2025-01-14T10:00:00Z\"). Only used during app creation."}}}}
```

## The hq\_K2KErrorHandlingBehavior object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]}}}}
```

## The hq\_K2KErrorHandlingSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]}}}}
```

## The hq\_K2KTracingHeadersSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}}}}}
```

## The hq\_K2KCommitCoordinationSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}}}}}
```

## The hq\_K2KAssignmentCoordinationSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}}}}}
```

## The hq\_K2KCoordinationSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}}}}}
```

## The hq\_K2KBidirectionalMode object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]}}}}
```

## The hq\_K2KBidirectionalSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]}}}}
```

## The hq\_K2KReplicatorSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KReplicatorSettings":{"type":"object","description":"Provides additional control knobs for the K2K replicator.","properties":{"schemaMapping":{"type":"boolean","description":"Enables schema replication."},"exactlyOnce":{"type":"boolean","description":"Enables exactly-once processing."},"headerReplication":{"type":"boolean","description":"Replicates the record headers."},"autoCreateTopics":{"type":"boolean","description":"Enables auto creation of topics."},"autoCreateControlTopics":{"type":"boolean","description":"Enables auto creation of control topics."},"keepRecordCreationTimestamp":{"type":"boolean","description":"Enables preserving record timestamps."},"errorHandling":{"$ref":"#/components/schemas/hq_K2KErrorHandlingSettings"},"tracingHeaders":{"$ref":"#/components/schemas/hq_K2KTracingHeadersSettings"},"coordination":{"$ref":"#/components/schemas/hq_K2KCoordinationSettings"},"bidirectional":{"$ref":"#/components/schemas/hq_K2KBidirectionalSettings"}}},"hq_K2KErrorHandlingSettings":{"type":"object","description":"Controls K2K error handling behavior.","properties":{"onCommitSyncTimeout":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"},"onControlMessageDeserializationError":{"$ref":"#/components/schemas/hq_K2KErrorHandlingBehavior"}}},"hq_K2KErrorHandlingBehavior":{"type":"string","description":"Specifies error handling behavior.","enum":["fail","ignore"]},"hq_K2KTracingHeadersSettings":{"type":"object","description":"Controls which tracing headers are enabled.","properties":{"partition":{"type":"boolean","description":"Enables the partition tracing header."},"offset":{"type":"boolean","description":"Enables the offset tracing header."},"topic":{"type":"boolean","description":"Enables the topic tracing header."},"pipeline":{"type":"boolean","description":"Enables the pipeline tracing header."}}},"hq_K2KCoordinationSettings":{"type":"object","description":"Controls coordination behavior.","properties":{"commit":{"$ref":"#/components/schemas/hq_K2KCommitCoordinationSettings"},"assignment":{"$ref":"#/components/schemas/hq_K2KAssignmentCoordinationSettings"}}},"hq_K2KCommitCoordinationSettings":{"type":"object","description":"Controls commit coordination settings.","properties":{"topic":{"type":"string","description":"Topic for offset commits."},"syncTimeoutSeconds":{"type":"integer","description":"Time limit in seconds to wait for catchup when reading from the offset control topic.","minimum":1},"batchSize":{"type":"integer","description":"Number of records after which an offset is committed.","minimum":1},"batchTimeoutSeconds":{"type":"integer","description":"Time in seconds to wait before injecting a commit record.","minimum":1}}},"hq_K2KAssignmentCoordinationSettings":{"type":"object","description":"Controls assignment coordination settings.","properties":{"topic":{"type":"string","description":"Topic used for assignment coordination."},"graceWindowSeconds":{"type":"integer","description":"Time in seconds to wait before the application actively fences off other applications.","minimum":1},"fencingMaxParallelism":{"type":"integer","description":"Max parallelism when fencing slow/zombie producers.","minimum":1}}},"hq_K2KBidirectionalSettings":{"type":"object","description":"Controls bidirectional replication behavior.","properties":{"enabled":{"type":"boolean","description":"Enables bidirectional replication."},"mode":{"$ref":"#/components/schemas/hq_K2KBidirectionalMode"},"headerName":{"type":"string","description":"Header name for bidirectional replication detection."}}},"hq_K2KBidirectionalMode":{"type":"string","description":"Controls the bidirectional replication detection identifier. This\nprevents records that are already present in both clusters from being\nreplicated. \"cluster\" uses the source broker's ID; \"pipeline\" uses the\npipeline name set in the configuration.\n","enum":["cluster","pipeline"]}}}}
```

## The hq\_K2KAppStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppStatus":{"type":"object","description":"Contains the most recently observed status of a K2KApp. Read-only for clients.","properties":{"updatedAt":{"type":"string","format":"date-time","description":"Contains the time instant this object was updated."},"state":{"$ref":"#/components/schemas/hq_K2KAppState"},"statusLastTransitionAt":{"type":"string","format":"date-time","description":"Contains the time instant the status was changed."},"statusMessage":{"type":"string","description":"Is a human-readable message indicating details about last the transition."},"observedGeneration":{"type":"integer","description":"Reflects the generation of the spec that this status corresponds to."},"deployment":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatus"},"kafka":{"$ref":"#/components/schemas/hq_K2KAppKafkaStatus"}},"required":["updatedAt","state","statusLastTransitionAt","statusMessage","observedGeneration","deployment","kafka"]},"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]},"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}},"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]}}}}
```

## The hq\_K2KAppKafkaStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppKafkaStatus":{"type":"object","properties":{"consumerGroup":{"type":"string","description":"Holds the name of the consumer group that this K2KApp uses."}},"required":["consumerGroup"]}}}}
```

## The hq\_KubernetesDeploymentStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KubernetesDeploymentStatus":{"type":"object","description":"Provides information about a Kubernetes deployment.","properties":{"inSync":{"type":"boolean"},"managedResources":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusResource"}},"pods":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesDeploymentStatusPod"}}},"required":["inSync","managedResources","pods"]},"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]},"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}}}}}
```

## The hq\_KubernetesDeploymentStatusResource object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KubernetesDeploymentStatusResource":{"type":"object","description":"Provides information about a Kubernetes resource.","properties":{"name":{"type":"string","description":"Holds the resource name."},"namespace":{"type":"string","description":"Is set to the resource's namespace."},"kind":{"type":"string","description":"Is set to the resource's kind, e.g. Deployment, ConfigMap, etc."},"status":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Created, Updated, InSync, Error."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way."}},"required":["name","namespace","kind","status"]}}}}
```

## The hq\_KubernetesDeploymentStatusPod object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KubernetesDeploymentStatusPod":{"type":"object","properties":{"name":{"type":"string","description":"Holds the Pod name."},"namespace":{"type":"string","description":"Is set to the Pod's namespace."},"state":{"type":"string","description":"Contains a one-word status of a loosely defined enum: Terminating, CrashLoopBackOff, Running, etc."},"reason":{"type":"string","description":"Elaborates on the status in a human-readably way, if possible."},"lastTermination":{"$ref":"#/components/schemas/hq_PodTerminationDetails"}},"required":["name","namespace","state"]},"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}}}}}
```

## The hq\_K8sDeploymentOverrides object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sDeploymentOverrides":{"type":"object","properties":{"commonMetadata":{"$ref":"#/components/schemas/hq_K8sMetadata"},"securityContext":{"$ref":"#/components/schemas/hq_K8sSecurityContext"},"imagePullSecrets":{"type":"array","description":"Are passed to the Deployment's imagePullSecrets.","items":{"$ref":"#/components/schemas/hq_K8sLocalObjectReference"}},"serviceAccount":{"type":"string","description":"Is the name of the ServiceAccount to use to run pods.","format":"K8sDns1123Subdomain"},"image":{"type":"string","description":"Overrides the default image deployed."},"resources":{"$ref":"#/components/schemas/hq_K8sResourceRequirements"}}},"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}},"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}},"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]},"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}}}}}
```

## The hq\_K8sMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sMetadata":{"type":"object","description":"Bundles K8s labels and annotations.","properties":{"labels":{"$ref":"#/components/schemas/hq_K8sStringMap"},"annotations":{"$ref":"#/components/schemas/hq_K8sStringMap"}}},"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}}}}}
```

## The hq\_K8sResourceList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}}}}}
```

## The hq\_K8sResourceRequirements object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sResourceRequirements":{"type":"object","description":"Mirrors a K8s core v1 ResourceRequirements.","properties":{"requests":{"$ref":"#/components/schemas/hq_K8sResourceList"},"limits":{"$ref":"#/components/schemas/hq_K8sResourceList"}}},"hq_K8sResourceList":{"type":"object","description":"Mirrors a K8s core v1 ResourceList.","properties":{"cpu":{"type":"string","format":"K8sResourceQuantity"},"memory":{"type":"string","format":"K8sResourceQuantity"}}}}}}
```

## The hq\_K8sSecurityContext object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sSecurityContext":{"type":"object","description":"Allows customisation of a deployment's SecurityContext. Partially\nmirrors a K8s core v1 SecurityContext.\n","properties":{"runAsUser":{"type":"integer","format":"int64","description":"Sets the UID to run the entrypoint of the container process."},"runAsGroup":{"type":"integer","format":"int64","description":"Sets the GID to run the entrypoint of the container process."},"runAsNonRoot":{"type":"boolean","description":"Indicates that the container must run as a non-root user."}}}}}}
```

## The hq\_K8sLocalObjectReference object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sLocalObjectReference":{"type":"object","description":"Mirrors a K8s core v1 LocalObjectReference.","properties":{"name":{"type":"string","description":"Name of the referent.","format":"K8sDns1123Subdomain"}},"required":["name"]}}}}
```

## The hq\_K8sStringMap object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K8sStringMap":{"type":"object","description":"Maps string keys to string values. Used for K8s labels and annotations.","additionalProperties":{"type":"string"}}}}}
```

## The hq\_K2KAppState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppState":{"type":"string","description":"Enumerates K2KApp state types.","enum":["deploying","starting","running","paused","error","deleting"]}}}}
```

## The hq\_K2KAppMetricsState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KAppMetricsState":{"type":"string","description":"Enumerates K2KApp metrics states.","enum":["unknown","success","error"]}}}}
```

## The hq\_K2KMigrationEvent object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KMigrationEvent":{"type":"object","description":"Represents an event that occurred during a K2K migration.","properties":{"time":{"type":"string","format":"date-time","description":"The timestamp when the event occurred."},"message":{"type":"string","description":"A human-readable description of the event."},"offsets":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"},"description":"Optional list of topic-partition-offsets associated with this event."}},"required":["time","message"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KMigration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KMigration":{"type":"object","description":"Represents a K2K consumer group offset migration.","properties":{"name":{"type":"string","description":"The unique name of the migration."},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the migration was created."},"k2k_app":{"type":"string","description":"The name of the K2K app this migration is associated with."},"consumer_group_id":{"type":"string","description":"The ID of the consumer group being migrated."},"status":{"$ref":"#/components/schemas/hq_K2KMigrationStatus"},"status_message":{"type":"string","description":"A human-readable message about the current status."},"allowed_next_states":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KMigrationAction"},"description":"Lists user-triggerable actions available from the current state."},"events":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KMigrationEvent"},"description":"Lists events that have occurred during the migration."}},"required":["name","display_name","lrn","id","created_at","k2k_app","consumer_group_id","status","status_message","allowed_next_states","events"]},"hq_K2KMigrationStatus":{"type":"string","description":"Enumerates K2K migration status types.","enum":["check_migration_readiness","migration_readiness_confirmed","migrate_offsets","offsets_migrated","migration_done","check_rollback_readiness","rollback_readiness_confirmed","rollback_offsets","offsets_rolled_back","rollback_done","error"]},"hq_K2KMigrationAction":{"type":"string","description":"User-triggerable migration actions.","enum":["check_migration_readiness","migrate_offsets","migration_done","check_rollback_readiness","rollback_offsets","rollback_done"]},"hq_K2KMigrationEvent":{"type":"object","description":"Represents an event that occurred during a K2K migration.","properties":{"time":{"type":"string","format":"date-time","description":"The timestamp when the event occurred."},"message":{"type":"string","description":"A human-readable description of the event."},"offsets":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"},"description":"Optional list of topic-partition-offsets associated with this event."}},"required":["time","message"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KMigrationList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KMigrationList":{"type":"object","description":"Contains a list of K2K migrations.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KMigration"}}},"required":["items"]},"hq_K2KMigration":{"type":"object","description":"Represents a K2K consumer group offset migration.","properties":{"name":{"type":"string","description":"The unique name of the migration."},"display_name":{"type":"string"},"lrn":{"type":"string","description":"Contains the resource identifier for use in access control policies."},"id":{"type":"string"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the migration was created."},"k2k_app":{"type":"string","description":"The name of the K2K app this migration is associated with."},"consumer_group_id":{"type":"string","description":"The ID of the consumer group being migrated."},"status":{"$ref":"#/components/schemas/hq_K2KMigrationStatus"},"status_message":{"type":"string","description":"A human-readable message about the current status."},"allowed_next_states":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KMigrationAction"},"description":"Lists user-triggerable actions available from the current state."},"events":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KMigrationEvent"},"description":"Lists events that have occurred during the migration."}},"required":["name","display_name","lrn","id","created_at","k2k_app","consumer_group_id","status","status_message","allowed_next_states","events"]},"hq_K2KMigrationStatus":{"type":"string","description":"Enumerates K2K migration status types.","enum":["check_migration_readiness","migration_readiness_confirmed","migrate_offsets","offsets_migrated","migration_done","check_rollback_readiness","rollback_readiness_confirmed","rollback_offsets","offsets_rolled_back","rollback_done","error"]},"hq_K2KMigrationAction":{"type":"string","description":"User-triggerable migration actions.","enum":["check_migration_readiness","migrate_offsets","migration_done","check_rollback_readiness","rollback_offsets","rollback_done"]},"hq_K2KMigrationEvent":{"type":"object","description":"Represents an event that occurred during a K2K migration.","properties":{"time":{"type":"string","format":"date-time","description":"The timestamp when the event occurred."},"message":{"type":"string","description":"A human-readable description of the event."},"offsets":{"type":"array","items":{"$ref":"#/components/schemas/hq_K2KTopicPartitionOffset"},"description":"Optional list of topic-partition-offsets associated with this event."}},"required":["time","message"]},"hq_K2KTopicPartitionOffset":{"type":"object","description":"A topic-partition-offset tuple specifying the position to update.","properties":{"topic":{"type":"string","description":"The name of the Kafka topic."},"topic_name":{"type":"string","description":"DEPRECATED: Use 'topic' instead. This field is kept for backward compatibility.\nThe name of the Kafka topic.\n","deprecated":true},"partition":{"type":"integer","format":"int32","description":"The partition number for the given topic.","minimum":0},"offset":{"type":"integer","format":"int64","description":"The offset value to set for the given topic-partition.","minimum":0}},"required":["partition","offset"]}}}}
```

## The hq\_K2KMigrationStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KMigrationStatus":{"type":"string","description":"Enumerates K2K migration status types.","enum":["check_migration_readiness","migration_readiness_confirmed","migrate_offsets","offsets_migrated","migration_done","check_rollback_readiness","rollback_readiness_confirmed","rollback_offsets","offsets_rolled_back","rollback_done","error"]}}}}
```

## The hq\_K2KMigrationAction object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_K2KMigrationAction":{"type":"string","description":"User-triggerable migration actions.","enum":["check_migration_readiness","migrate_offsets","migration_done","check_rollback_readiness","rollback_offsets","rollback_done"]}}}}
```

## The hq\_CreateK2KMigrationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateK2KMigrationRequest":{"type":"object","description":"Request body for creating a new K2K migration.","properties":{"name":{"type":"string","description":"The unique name for the migration.","minLength":1,"maxLength":63,"format":"hq-resource-name"},"display_name":{"type":"string","maxLength":150,"description":"Sets the display name of the new K2KMigration. If not provided,\nthe value of \"name\" will be used.\n"},"k2k_app":{"type":"string","description":"The K2K app migrating the data the consumer group processes.","minLength":1,"format":"hq-resource-name"},"consumer_group_id":{"type":"string","description":"The ID of the consumer group whose offsets should be migrated.","minLength":1}},"required":["name","k2k_app","consumer_group_id"]}}}}
```

## The hq\_UpdateK2KMigrationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateK2KMigrationRequest":{"type":"object","description":"Request body for updating the state of a K2K migration.","properties":{"status":{"$ref":"#/components/schemas/hq_K2KMigrationAction"}},"required":["status"]},"hq_K2KMigrationAction":{"type":"string","description":"User-triggerable migration actions.","enum":["check_migration_readiness","migrate_offsets","migration_done","check_rollback_readiness","rollback_offsets","rollback_done"]}}}}
```

## The hq\_Order object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Order":{"type":"string","enum":["asc","desc"]}}}}
```

## The hq\_DatasetField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetField":{"type":"string","enum":["name","records","connectionName","sourceType","isSystemEntity","recordsPerSecond","keyType","valueType","replication","consumers","partitions","retentionBytes","retentionMs","sizeBytes","replicas","shard","version","format","compatibility","backupRestoreState"]}}}}
```

## The hq\_DatasetBulkDeleteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetBulkDeleteRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetBulkDeleteRequestItem"}}}},"hq_DatasetBulkDeleteRequestItem":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The hq\_DatasetBulkDeleteRequestItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetBulkDeleteRequestItem":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The hq\_DatasetBulkDeleteResult object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetBulkDeleteResult":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetBulkDeleteResultItem"}}}},"hq_DatasetBulkDeleteResultItem":{"required":["id","success"],"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"}}}}}}
```

## The hq\_DatasetBulkDeleteResultItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetBulkDeleteResultItem":{"required":["id","success"],"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"}}}}}}
```

## The hq\_DatasetResults object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetResults":{"required":["datasets"],"type":"object","properties":{"datasets":{"$ref":"#/components/schemas/hq_Page_DatasetMatch"},"sourceTypes":{"type":"array","items":{"$ref":"#/components/schemas/hq_SourceType"}}}},"hq_Page_DatasetMatch":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_Kafka"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"hq_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","sourceType","lrn"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/hq_BackupRestoreState"},"sourceType":{"type":"string"},"lrn":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/hq_Backup"},{"$ref":"#/components/schemas/hq_BackupRestore"},{"$ref":"#/components/schemas/hq_Restore"}]},"hq_Backup":{"type":"object"},"hq_BackupRestore":{"type":"object"},"hq_Restore":{"type":"object"},"hq_SourceType":{"type":"string","enum":["Kafka","Elastic","Postgres","SchemaRegistrySubject"]}}}}
```

## The hq\_SourceType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SourceType":{"type":"string","enum":["Kafka","Elastic","Postgres","SchemaRegistrySubject"]}}}}
```

## The hq\_Page\_DatasetMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Page_DatasetMatch":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_Kafka"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"hq_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","sourceType","lrn"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/hq_BackupRestoreState"},"sourceType":{"type":"string"},"lrn":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/hq_Backup"},{"$ref":"#/components/schemas/hq_BackupRestore"},{"$ref":"#/components/schemas/hq_Restore"}]},"hq_Backup":{"type":"object"},"hq_BackupRestore":{"type":"object"},"hq_Restore":{"type":"object"}}}}
```

## The hq\_DatasetMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetMatch":{"oneOf":[{"$ref":"#/components/schemas/hq_Kafka"},{"$ref":"#/components/schemas/hq_SchemaRegistrySubject"}],"discriminator":{"propertyName":"sourceType","mapping":{"Kafka":"#/components/schemas/hq_Kafka","SchemaRegistrySubject":"#/components/schemas/hq_SchemaRegistrySubject"}}},"hq_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","sourceType","lrn"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/hq_BackupRestoreState"},"sourceType":{"type":"string"},"lrn":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/hq_Backup"},{"$ref":"#/components/schemas/hq_BackupRestore"},{"$ref":"#/components/schemas/hq_Restore"}]},"hq_Backup":{"type":"object"},"hq_BackupRestore":{"type":"object"},"hq_Restore":{"type":"object"},"hq_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaVersion"},"minItems":1},"sourceType":{"type":"string"}}},"hq_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"hq_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaReference"}}}}}}}
```

## The hq\_Kafka object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","sourceType","lrn"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/hq_BackupRestoreState"},"sourceType":{"type":"string"},"lrn":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/hq_Backup"},{"$ref":"#/components/schemas/hq_BackupRestore"},{"$ref":"#/components/schemas/hq_Restore"}]},"hq_Backup":{"type":"object"},"hq_BackupRestore":{"type":"object"},"hq_Restore":{"type":"object"}}}}
```

## The hq\_DatasetTagsList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetTagsList":{"required":["tags"],"type":"object","description":"List of tags saved in one agent.","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}}}}}
```

## The hq\_DailyMessages object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DailyMessages":{"required":["date"],"type":"object","properties":{"date":{"type":"string","format":"date-time"},"messagesCount":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_TopicSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicSummary":{"required":["topicName","lrn","partitions","replication","isControlTopic","keyType","valueType","totalMessages","configs","consumers","messagesPerSecond","isMarkedForDeletion","isCompacted","tags"],"type":"object","properties":{"topicName":{"type":"string"},"lrn":{"type":"string"},"partitions":{"type":"integer"},"replication":{"type":"integer"},"isControlTopic":{"type":"boolean"},"keyType":{"type":"string"},"valueType":{"type":"string"},"totalMessages":{"type":"integer","format":"int64"},"configs":{"type":"integer","format":"int64"},"consumers":{"type":"integer","format":"int64"},"messagesPerSecond":{"type":"integer","format":"int64"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"description":{"type":"string"},"size":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}}}}}
```

## The hq\_TopicSummaryWithSchema object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicSummaryWithSchema":{"required":["topicName","partitions","replication","isControlTopic","isCompacted","keyType","valueType","totalMessages","messagesPerSecond","isMarkedForDeletion","timestamp"],"type":"object","properties":{"topicName":{"type":"string"},"partitions":{"type":"integer"},"replication":{"type":"integer"},"isControlTopic":{"type":"boolean"},"isCompacted":{"type":"boolean"},"keyType":{"type":"string"},"valueType":{"type":"string"},"totalMessages":{"type":"integer","format":"int64"},"config":{"type":"array","items":{"$ref":"#/components/schemas/hq_TableProperty"}},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumersGroupInfoShort"}},"messagesPerPartition":{"type":"array","items":{"$ref":"#/components/schemas/hq_MessagesPerPartition"}},"messagesPerSecond":{"type":"integer","format":"int64"},"isMarkedForDeletion":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"keySchema":{"type":"string"},"keySchemaVersion":{"type":"integer"},"keySchemaInlined":{"type":"string"},"valueSchema":{"type":"string"},"valueSchemaVersion":{"type":"integer"},"valueSchemaInlined":{"type":"string"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/hq_Application"}},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"permissions":{"type":"array","items":{"type":"string"}},"backups":{"type":"array","items":{"$ref":"#/components/schemas/hq_BackupRestoreSummary"}},"restores":{"type":"array","items":{"$ref":"#/components/schemas/hq_BackupRestoreSummary"}}}},"hq_TableProperty":{"required":["name","value","isDefault","originalValue"],"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"},"defaultValue":{"type":"string"},"documentation":{"type":"string"},"originalValue":{"type":"string"}}},"hq_ConsumersGroupInfoShort":{"required":["id","coordinator","active","state","consumersCount","topicPartitionsCount"],"type":"object","properties":{"id":{"type":"string"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerCoordinator"},"active":{"type":"boolean"},"state":{"$ref":"#/components/schemas/hq_ConsumerGroupState"},"consumers":{"type":"array","items":{"type":"string"}},"consumersCount":{"type":"integer"},"topicPartitionsCount":{"type":"integer"},"minLag":{"type":"integer","format":"int64"},"maxLag":{"type":"integer","format":"int64"},"application":{"$ref":"#/components/schemas/hq_Application"}}},"hq_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}},"hq_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]},"hq_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_ApplicationType"}}},"hq_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]},"hq_MessagesPerPartition":{"required":["partition","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_BackupRestoreSummary":{"required":["id","createdAt","topic","connectCluster","connectorName","connectorVersion","s3Location"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"topic":{"type":"string"},"connectCluster":{"type":"string"},"connectorName":{"type":"string"},"connectorVersion":{"type":"string"},"s3Location":{"type":"string"},"reference":{"type":"string"}}}}}}
```

## The hq\_TableProperty object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TableProperty":{"required":["name","value","isDefault","originalValue"],"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"},"defaultValue":{"type":"string"},"documentation":{"type":"string"},"originalValue":{"type":"string"}}}}}}
```

## The hq\_MessagesPerPartition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_MessagesPerPartition":{"required":["partition","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_BackupRestoreSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupRestoreSummary":{"required":["id","createdAt","topic","connectCluster","connectorName","connectorVersion","s3Location"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"topic":{"type":"string"},"connectCluster":{"type":"string"},"connectorName":{"type":"string"},"connectorVersion":{"type":"string"},"s3Location":{"type":"string"},"reference":{"type":"string"}}}}}}
```

## The hq\_Application object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_ApplicationType"}}},"hq_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The hq\_ConsumerCoordinator object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}}}}}
```

## The hq\_ConsumerGroupState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]}}}}
```

## The hq\_ApplicationType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The hq\_ConsumersGroupInfoShort object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumersGroupInfoShort":{"required":["id","coordinator","active","state","consumersCount","topicPartitionsCount"],"type":"object","properties":{"id":{"type":"string"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerCoordinator"},"active":{"type":"boolean"},"state":{"$ref":"#/components/schemas/hq_ConsumerGroupState"},"consumers":{"type":"array","items":{"type":"string"}},"consumersCount":{"type":"integer"},"topicPartitionsCount":{"type":"integer"},"minLag":{"type":"integer","format":"int64"},"maxLag":{"type":"integer","format":"int64"},"application":{"$ref":"#/components/schemas/hq_Application"}}},"hq_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}},"hq_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]},"hq_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_ApplicationType"}}},"hq_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The hq\_Highlight object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The hq\_Fields object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The hq\_Field object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The hq\_FieldTypeDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}}}}}
```

## The hq\_DatasetTag object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}}}}}
```

## The hq\_BackupRestoreState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/hq_Backup"},{"$ref":"#/components/schemas/hq_BackupRestore"},{"$ref":"#/components/schemas/hq_Restore"}]},"hq_Backup":{"type":"object"},"hq_BackupRestore":{"type":"object"},"hq_Restore":{"type":"object"}}}}
```

## The hq\_PolicyMatchDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_BackupRestore object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupRestore":{"type":"object"}}}}
```

## The hq\_Backup object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Backup":{"type":"object"}}}}
```

## The hq\_Restore object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Restore":{"type":"object"}}}}
```

## The hq\_Lenses object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}}}}}
```

## The hq\_Native object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}}}}}
```

## The hq\_PolicyFieldMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_StatementPos object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_StatementPos":{"required":["index","start","end"],"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The hq\_Suggestion object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Suggestion":{"required":["display","text","start","end","type","highlightStart","highlightEnd"],"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}}}}}
```

## The hq\_HintType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]}}}}
```

## The hq\_Lint object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Lint":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_HintType"}}},"hq_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]}}}}
```

## The hq\_Highlight1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Highlight1":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_HighlightType"}}},"hq_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]}}}}
```

## The hq\_HighlightType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]}}}}
```

## The hq\_PresentationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PresentationRequest":{"required":["sql"],"type":"object","properties":{"sql":{"type":"string"},"caret":{"type":"integer"},"connectorId":{"type":"string"}}}}}}
```

## The hq\_TableName object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The hq\_FieldName object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The hq\_TableFields object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TableFields":{"required":["tableName"],"type":"object","properties":{"tableName":{"$ref":"#/components/schemas/hq_TableName"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/hq_FieldName"}}}},"hq_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"hq_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The hq\_Presentation object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Presentation":{"required":["input","caret"],"type":"object","properties":{"input":{"type":"string"},"caret":{"type":"integer"},"lints":{"type":"array","items":{"$ref":"#/components/schemas/hq_Lint"}},"suggestions":{"type":"array","items":{"$ref":"#/components/schemas/hq_Suggestion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight1"}},"tables":{"type":"array","items":{"$ref":"#/components/schemas/hq_TableFields"}},"statementsPositions":{"type":"array","items":{"$ref":"#/components/schemas/hq_StatementPos"}}}},"hq_Lint":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_HintType"}}},"hq_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]},"hq_Suggestion":{"required":["display","text","start","end","type","highlightStart","highlightEnd"],"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}},"hq_Highlight1":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/hq_HighlightType"}}},"hq_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]},"hq_TableFields":{"required":["tableName"],"type":"object","properties":{"tableName":{"$ref":"#/components/schemas/hq_TableName"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/hq_FieldName"}}}},"hq_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"hq_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"hq_StatementPos":{"required":["index","start","end"],"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The hq\_SinglePartitionOffsetRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SinglePartitionOffsetRequest":{"required":["offset","type"],"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"type":{"type":"string"}}}}}}
```

## The hq\_ConfigDefaultsList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConfigDefaultsList":{"type":"array","description":"List of config defaults","items":{"$ref":"#/components/schemas/hq_ConfigDefaultsItem"}},"hq_ConfigDefaultsItem":{"type":"object","description":"Config defaults list item","properties":{"key":{"type":"string","description":"Configuration key"},"default":{"type":"object","description":"Configuration defaults","properties":{"default":{"type":"string","description":"Default value"},"serverDefaultProperties":{"type":"string","description":"Server property"},"description":{"type":"string","description":"Property description"}}}}}}}}
```

## The hq\_ConfigDefaultsItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConfigDefaultsItem":{"type":"object","description":"Config defaults list item","properties":{"key":{"type":"string","description":"Configuration key"},"default":{"type":"object","description":"Configuration defaults","properties":{"default":{"type":"string","description":"Default value"},"serverDefaultProperties":{"type":"string","description":"Server property"},"description":{"type":"string","description":"Property description"}}}}}}}}
```

## The hq\_SetTopicConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SetTopicConfiguration":{"type":"object","properties":{"configs":{"type":"array","items":{"$ref":"#/components/schemas/hq_TopicConfigKeyValue"}}}},"hq_TopicConfigKeyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_TopicConfigKeyValue object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicConfigKeyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_ClustersInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ClustersInfo":{"type":"object","properties":{"kubernetes":{"type":"array","items":{"$ref":"#/components/schemas/hq_KubernetesCluster"}},"connect":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConnectCluster"}}}},"hq_KubernetesCluster":{"required":["cluster","version"],"type":"object","properties":{"cluster":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"}}},"hq_ConnectCluster":{"required":["cluster","version"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"}}}}}}
```

## The hq\_AgentProvisioning object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AgentProvisioning":{"type":"string"}}}}
```

## The hq\_KubernetesCluster object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KubernetesCluster":{"required":["cluster","version"],"type":"object","properties":{"cluster":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"}}}}}}
```

## The hq\_ConnectCluster object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectCluster":{"required":["cluster","version"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"}}}}}}
```

## The hq\_CreateTopicRequestV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateTopicRequestV1":{"required":["name","configs","format"],"type":"object","properties":{"name":{"type":"string"},"replication":{"type":"integer"},"partitions":{"type":"integer"},"configs":{"$ref":"#/components/schemas/hq_Map_String_String"},"format":{"$ref":"#/components/schemas/hq_CreateTopicMessageFormatV1"}}},"hq_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}},"hq_CreateTopicMessageFormatV1":{"required":["key","value"],"type":"object","properties":{"key":{"$ref":"#/components/schemas/hq_CreateTopicDataFormatV1"},"value":{"$ref":"#/components/schemas/hq_CreateTopicDataFormatV1"}}},"hq_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/hq_DecoderType"},"schema":{"type":"string"}}},"hq_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The hq\_Map\_String\_String object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The hq\_CreateTopicMessageFormatV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateTopicMessageFormatV1":{"required":["key","value"],"type":"object","properties":{"key":{"$ref":"#/components/schemas/hq_CreateTopicDataFormatV1"},"value":{"$ref":"#/components/schemas/hq_CreateTopicDataFormatV1"}}},"hq_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/hq_DecoderType"},"schema":{"type":"string"}}},"hq_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The hq\_CreateTopicDataFormatV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/hq_DecoderType"},"schema":{"type":"string"}}},"hq_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The hq\_DecoderType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The hq\_BulkPartitionOffsetRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BulkPartitionOffsetRequest":{"oneOf":[{"$ref":"#/components/schemas/hq_PartitionOffsetEnd"},{"$ref":"#/components/schemas/hq_PartitionOffsetStart"},{"$ref":"#/components/schemas/hq_PartitionOffsetTimestamp"}]},"hq_PartitionOffsetEnd":{"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}},"hq_PartitionOffsetStart":{"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}},"hq_PartitionOffsetTimestamp":{"required":["target"],"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"target":{"type":"string","format":"date-time"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_BulkPartitionOffsetRequestType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BulkPartitionOffsetRequestType":{"type":"string","description":"Enumerates possible request types.","enum":["start","end","timestamp"]}}}}
```

## The hq\_PartitionOffsetEnd object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionOffsetEnd":{"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_PartitionOffsetStart object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionOffsetStart":{"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_PartitionOffsetTimestamp object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionOffsetTimestamp":{"required":["target"],"type":"object","properties":{"type":{"type":"BulkPartitionOffsetRequestType"},"target":{"type":"string","format":"date-time"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_TableMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TableMetadata":{"required":["topicName","keyType","valueType"],"type":"object","properties":{"topicName":{"type":"string"},"keyType":{"type":"string"},"valueType":{"type":"string"},"keySchema":{"type":"string"},"keySchemaVersion":{"type":"integer"},"keySchemaInlined":{"type":"string"},"valueSchema":{"type":"string"},"valueSchemaVersion":{"type":"integer"},"valueSchemaInlined":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"additionalInfo":{"$ref":"#/components/schemas/hq_Json"}}},"hq_Json":{}}}}
```

## The hq\_Json object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Json":{}}}}
```

## The hq\_Decoders object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_Decoders":{"required":["keys","values"],"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_BackupRestoreResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupRestoreResponse":{"required":["id","connector","cluster"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"connector":{"type":"string"},"cluster":{"type":"string"}}}}}}
```

## The hq\_BackupTopicRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupTopicRequest":{"required":["cluster","s3"],"type":"object","properties":{"cluster":{"type":"string"},"s3":{"$ref":"#/components/schemas/hq_S3Bucket"},"flush":{"$ref":"#/components/schemas/hq_BackupFlushSettings"}}},"hq_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}},"hq_BackupFlushSettings":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"interval":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_S3Bucket object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}}}}}
```

## The hq\_BackupFlushSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_BackupFlushSettings":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"interval":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_RestoreTopicRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_RestoreTopicRequest":{"required":["cluster","s3","storageFormat"],"type":"object","properties":{"cluster":{"type":"string"},"s3":{"$ref":"#/components/schemas/hq_S3Bucket"},"storageFormat":{"$ref":"#/components/schemas/hq_S3StorageFormat"}}},"hq_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}},"hq_S3StorageFormat":{"type":"string","enum":["avro","parquet","json"]}}}}
```

## The hq\_S3StorageFormat object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_S3StorageFormat":{"type":"string","enum":["avro","parquet","json"]}}}}
```

## The hq\_PartitionIncrease object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionIncrease":{"required":["partitions"],"type":"object","properties":{"partitions":{"type":"integer"}}}}}}
```

## The hq\_PartitionReplica object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The hq\_PartitionV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionV2":{"required":["partition","leader","preferredLeader","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"leader":{"type":"integer"},"preferredLeader":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"},"bytes":{"type":"integer","format":"int64"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_PartitionReplica"}}}},"hq_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The hq\_PartitionDTO object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionDTO":{"type":"object","properties":{"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_PartitionV2"}},"jmxLastRetrievedAt":{"type":"string","format":"date-time"}}},"hq_PartitionV2":{"required":["partition","leader","preferredLeader","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"leader":{"type":"integer"},"preferredLeader":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"},"bytes":{"type":"integer","format":"int64"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_PartitionReplica"}}}},"hq_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The hq\_InferenceJobRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_InferenceJobRequest":{"required":["fromTimestamp"],"type":"object","properties":{"fromTimestamp":{"type":"integer","format":"int64"},"maxCount":{"type":"integer"},"maxSizeBytes":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_InferenceJobState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_InferenceJobState":{"required":["jobId","topicName","status","messagesProcessed","bytesProcessed","startedAtMs"],"type":"object","properties":{"jobId":{"type":"string","format":"uuid"},"topicName":{"type":"string"},"status":{"type":"string","enum":["RUNNING","COMPLETED","CANCELLED","FAILED"]},"error":{"type":"string"},"messagesProcessed":{"type":"integer","format":"int64"},"bytesProcessed":{"type":"integer","format":"int64"},"startedAtMs":{"type":"integer","format":"int64"},"finishedAtMs":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_InferenceJobLimits object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_InferenceJobLimits":{"required":["maxCount","maxSizeBytes"],"type":"object","properties":{"maxCount":{"type":"integer"},"maxSizeBytes":{"type":"integer","format":"int64"}}}}}}
```

## The hq\_ConnectionSummaryResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectionSummaryResponse":{"required":["name","templateName","templateVersion","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"templateVersion":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean","description":"Can the connection be deleted"}}}}}}
```

## The hq\_ProvisioningValidationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ProvisioningValidationResponse":{"type":"object","required":["valid","message","connections"],"properties":{"valid":{"type":"boolean","description":"Whether the overall validation passed"},"message":{"type":"string","description":"Summary message about the validation result"},"connections":{"type":"array","description":"Array of connection validation results","items":{"$ref":"#/components/schemas/hq_ConnectionValidationResult"}}}},"hq_ConnectionValidationResult":{"type":"object","required":["name","valid","error"],"properties":{"name":{"type":"string","description":"Name of the connection"},"valid":{"type":"boolean","description":"Whether this connection passed validation"},"error":{"type":"string","description":"Error details if validation failed"},"lineNumbers":{"type":"array","items":{"type":"integer"},"description":"1-based line numbers where the error occurred"},"fieldPaths":{"type":"array","items":{"type":"string"},"description":"Paths to the fields that caused the error (e.g., kafka.configuration.sslKeyPassword)"}}}}}}
```

## The hq\_ConnectionValidationResult object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectionValidationResult":{"type":"object","required":["name","valid","error"],"properties":{"name":{"type":"string","description":"Name of the connection"},"valid":{"type":"boolean","description":"Whether this connection passed validation"},"error":{"type":"string","description":"Error details if validation failed"},"lineNumbers":{"type":"array","items":{"type":"integer"},"description":"1-based line numbers where the error occurred"},"fieldPaths":{"type":"array","items":{"type":"string"},"description":"Paths to the fields that caused the error (e.g., kafka.configuration.sslKeyPassword)"}}}}}}
```

## The hq\_EndpointErrorBadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EndpointErrorBadRequest":{"type":"object","required":["type","error","fields"],"properties":{"type":{"type":"string","enum":["BadRequest"]},"error":{"type":"string","description":"Error message describing the parse/schema error"},"fields":{"type":"array","description":"Array of field-specific errors","items":{"$ref":"#/components/schemas/hq_FieldError"}},"errorType":{"type":"string","nullable":true}}},"hq_FieldError":{"type":"object","required":["field","error"],"properties":{"field":{"type":"string","description":"Field name that caused the error"},"error":{"type":"string","description":"Error message for this field"}}}}}}
```

## The hq\_EndpointErrorConflict object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EndpointErrorConflict":{"type":"object","required":["type","error","fields"],"properties":{"type":{"type":"string","enum":["Conflict"]},"error":{"type":"string","description":"Error message for conflict scenarios"},"fields":{"type":"array","description":"Array of field-specific errors","items":{"$ref":"#/components/schemas/hq_FieldError"}}}},"hq_FieldError":{"type":"object","required":["field","error"],"properties":{"field":{"type":"string","description":"Field name that caused the error"},"error":{"type":"string","description":"Error message for this field"}}}}}}
```

## The hq\_EndpointErrorInternal object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_EndpointErrorInternal":{"type":"object","required":["type","error","fields"],"properties":{"type":{"type":"string","enum":["InternalError"]},"error":{"type":"string","description":"Error message for internal server errors"},"fields":{"type":"array","description":"Array of field-specific errors","items":{"$ref":"#/components/schemas/hq_FieldError"}}}},"hq_FieldError":{"type":"object","required":["field","error"],"properties":{"field":{"type":"string","description":"Field name that caused the error"},"error":{"type":"string","description":"Error message for this field"}}}}}}
```

## The hq\_FieldError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_FieldError":{"type":"object","required":["field","error"],"properties":{"field":{"type":"string","description":"Field name that caused the error"},"error":{"type":"string","description":"Error message for this field"}}}}}}
```

## The hq\_SetConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SetConfig":{"required":["compatibility"],"type":"object","properties":{"compatibility":{"type":"string"}}}}}}
```

## The hq\_RegisterSchemaRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_RegisterSchemaRequest":{"required":["schema"],"type":"object","properties":{"schema":{"type":"string"},"format":{"type":"string"}}}}}}
```

## The hq\_RegisterSchemaResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_RegisterSchemaResponse":{"required":["version","schemaId"],"type":"object","properties":{"version":{"type":"integer"},"schemaId":{"type":"string"}}}}}}
```

## The hq\_SchemaRegistrySubject object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/hq_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyMatchDetails"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/hq_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaVersion"},"minItems":1},"sourceType":{"type":"string"}}},"hq_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"hq_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/hq_Field"}}}},"hq_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/hq_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"hq_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/hq_Lenses"},{"$ref":"#/components/schemas/hq_Native"}]},"hq_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"hq_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"hq_PolicyMatchDetails":{"required":["policyId","policyName","policyCategory","obfuscation"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_PolicyFieldMatch"}}}},"hq_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DatasetTag":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}}},"hq_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"hq_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaReference"}}}}}}}
```

## The hq\_SchemaVersion object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/hq_SchemaReference"}}}},"hq_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}}}}}
```

## The hq\_SchemaReference object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}}}}}
```

## The hq\_PodTerminationDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PodTerminationDetails":{"type":"object","properties":{"message":{"type":"string","description":"Last termination message of the pod's container."},"time":{"type":"string","format":"date-time","description":"When the last termination happened for the pod's container."}}}}}}
```

## The hq\_AlertSettingId object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertSettingId":{"type":"integer","description":"The alert setting ID","enum":[1000,1001,1002,1003,1005,1006,1007,1008,1009,1010,1011,1012,1013,1014,2000,3000,4000,4001,4002,5000,6000]}}}}
```

## The hq\_AlertEvent object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertEvent":{"type":"object","properties":{"level":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"instance":{"type":"string"},"summary":{"type":"string"},"docs":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"alertId":{"type":"integer"},"map":{"type":"object","additionalProperties":{"type":"string"}},"lrn":{"type":"string"}}}}}}
```

## The hq\_AlertEventsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertEventsResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_AlertEvent"}},"pagesAmount":{"type":"integer"},"totalCount":{"type":"integer"}}},"hq_AlertEvent":{"type":"object","properties":{"level":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"instance":{"type":"string"},"summary":{"type":"string"},"docs":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"alertId":{"type":"integer"},"map":{"type":"object","additionalProperties":{"type":"string"}},"lrn":{"type":"string"}}}}}}
```

## The hq\_AlertConditionChannelRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertConditionChannelRef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"}}}}}}
```

## The hq\_AlertConditionThreshold object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertConditionThreshold":{"type":"object","properties":{"type":{"type":"string"},"messages":{"type":"integer"}}}}}}
```

## The hq\_AlertConditionDsl object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertConditionDsl":{"type":"object","properties":{"connectionName":{"type":"string"},"datasetName":{"type":"string"},"threshold":{"$ref":"#/components/schemas/hq_AlertConditionThreshold"},"duration":{"type":"string"}}},"hq_AlertConditionThreshold":{"type":"object","properties":{"type":{"type":"string"},"messages":{"type":"integer"}}}}}}
```

## The hq\_AlertConditionDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertConditionDetails":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/hq_AlertConditionChannelRef"}},"condition":{"oneOf":[{"type":"object"},{"type":"string"}]},"conditionDsl":{"$ref":"#/components/schemas/hq_AlertConditionDsl"}}},"hq_AlertConditionChannelRef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"}}},"hq_AlertConditionDsl":{"type":"object","properties":{"connectionName":{"type":"string"},"datasetName":{"type":"string"},"threshold":{"$ref":"#/components/schemas/hq_AlertConditionThreshold"},"duration":{"type":"string"}}},"hq_AlertConditionThreshold":{"type":"object","properties":{"type":{"type":"string"},"messages":{"type":"integer"}}}}}}
```

## The hq\_AlertConditionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertConditionRequest":{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"object","description":"JSON Schema representation of the configuration properties"},{"type":"string"}]},"channels":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_AlertChannel object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AlertChannelsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelsResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_AlertChannel"}},"pagesAmount":{"type":"integer"},"totalCount":{"type":"integer"}}},"hq_AlertChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AlertChannelRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelRequest":{"type":"object","required":["name","templateName","connectionName"],"properties":{"name":{"type":"string"},"templateName":{"type":"string"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AlertChannelUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelUpdateRequest":{"type":"object","required":["name","connectionName"],"properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AlertChannelPatchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelPatchRequest":{"type":"object","properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AlertChannelCreatedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelCreatedResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The hq\_AlertChannelTemplateConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelTemplateConfiguration":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"placeholder":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}},"required":{"type":"boolean"},"provided":{"type":"boolean"}}}}}}
```

## The hq\_AlertChannelTemplateSuitableConnection object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelTemplateSuitableConnection":{"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The hq\_AlertChannelTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AlertChannelTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"templateVersion":{"type":"integer"},"version":{"type":"string"},"enabled":{"type":"boolean"},"builtIn":{"type":"boolean"},"metadata":{"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/hq_AlertChannelTemplateConfiguration"}},"suitableConnections":{"type":"array","items":{"$ref":"#/components/schemas/hq_AlertChannelTemplateSuitableConnection"}},"jsonSchema":{"type":"object","description":"JSON Schema for the template configuration"}}},"hq_AlertChannelTemplateConfiguration":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"placeholder":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}},"required":{"type":"boolean"},"provided":{"type":"boolean"}}},"hq_AlertChannelTemplateSuitableConnection":{"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The hq\_AuditAction object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditAction":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]}}}}
```

## The hq\_AuditType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditType":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]}}}}
```

## The hq\_AuditEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditEntry":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/hq_AuditType"},"action":{"$ref":"#/components/schemas/hq_AuditAction"},"user":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"content":{"type":"object","additionalProperties":{"type":"string"}}}},"hq_AuditType":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]},"hq_AuditAction":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]}}}}
```

## The hq\_AuditEntriesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditEntriesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditEntry"}},"pagesAmount":{"type":"integer"},"totalCount":{"type":"integer"}}},"hq_AuditEntry":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/hq_AuditType"},"action":{"$ref":"#/components/schemas/hq_AuditAction"},"user":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"content":{"type":"object","additionalProperties":{"type":"string"}}}},"hq_AuditType":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]},"hq_AuditAction":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]}}}}
```

## The hq\_AuditMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditMetadata":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditAction"}},"types":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditType"}}}},"hq_AuditAction":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]},"hq_AuditType":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]}}}}
```

## The hq\_AuditChannel object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AuditChannelsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelsResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditChannel"}},"pagesAmount":{"type":"integer"},"totalCount":{"type":"integer"}}},"hq_AuditChannel":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AuditChannelRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelRequest":{"type":"object","required":["name","templateName","connectionName"],"properties":{"name":{"type":"string"},"templateName":{"type":"string"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AuditChannelUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelUpdateRequest":{"type":"object","required":["name","connectionName"],"properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AuditChannelPatchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelPatchRequest":{"type":"object","properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/hq_ChannelProperty"}},"propertiesObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}},"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_AuditChannelCreatedResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelCreatedResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The hq\_AuditChannelTemplateConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelTemplateConfiguration":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"placeholder":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}},"required":{"type":"boolean"},"provided":{"type":"boolean"}}}}}}
```

## The hq\_AuditChannelTemplateSuitableConnection object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelTemplateSuitableConnection":{"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The hq\_AuditChannelTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditChannelTemplate":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"templateVersion":{"type":"integer"},"version":{"type":"string"},"enabled":{"type":"boolean"},"builtIn":{"type":"boolean"},"metadata":{"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditChannelTemplateConfiguration"}},"suitableConnections":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditChannelTemplateSuitableConnection"}},"jsonSchema":{"type":"object","description":"JSON Schema for the template configuration"}}},"hq_AuditChannelTemplateConfiguration":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"placeholder":{"type":"string"},"type":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}},"required":{"type":"boolean"},"provided":{"type":"boolean"}}},"hq_AuditChannelTemplateSuitableConnection":{"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The hq\_ChannelProperty object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ChannelProperty":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The hq\_KafkaAcl object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaAcl":{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"},"patternType":{"type":"string"},"principal":{"type":"string"},"permissionType":{"type":"string"},"host":{"type":"string"},"operation":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The hq\_KafkaAclRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaAclRequest":{"type":"object","required":["resourceType","resourceName","principal","permissionType","host","operation"],"properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"},"patternType":{"type":"string"},"principal":{"type":"string"},"permissionType":{"type":"string"},"host":{"type":"string"},"operation":{"type":"string"}}}}}}
```

## The hq\_KafkaAclDeleteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaAclDeleteRequest":{"type":"object","required":["resourceType","resourceName","principal","permissionType","host","operation","lrn"],"properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"},"patternType":{"type":"string"},"principal":{"type":"string"},"permissionType":{"type":"string"},"host":{"type":"string"},"operation":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The hq\_KafkaQuota object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaQuota":{"type":"object","properties":{"entityType":{"type":"string","description":"The type of entity (e.g., USERCLIENT, USER, CLIENT)"},"entityName":{"type":"string"},"child":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"url":{"type":"string"},"lrn":{"type":"string"},"isAuthorized":{"type":"boolean"}}}}}}
```

## The hq\_KafkaQuotaProperties object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_KafkaQuotaProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Quota properties as key-value pairs"}}}}
```

## The hq\_TopicPolicyConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPolicyConfig":{"type":"object","properties":{"partitions":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"replication":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"retention":{"type":"object","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}}}}
```

## The hq\_TopicPolicyNaming object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPolicyNaming":{"type":"object","properties":{"pattern":{"type":"string","description":"Regex pattern for topic name validation"},"description":{"type":"string"}}}}}}
```

## The hq\_TopicPolicy object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPolicy":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/hq_TopicPolicyConfig"},"naming":{"$ref":"#/components/schemas/hq_TopicPolicyNaming"}}},"hq_TopicPolicyConfig":{"type":"object","properties":{"partitions":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"replication":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"retention":{"type":"object","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}},"hq_TopicPolicyNaming":{"type":"object","properties":{"pattern":{"type":"string","description":"Regex pattern for topic name validation"},"description":{"type":"string"}}}}}}
```

## The hq\_TopicPolicyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPolicyRequest":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/hq_TopicPolicyConfig"},"naming":{"$ref":"#/components/schemas/hq_TopicPolicyNaming"}}},"hq_TopicPolicyConfig":{"type":"object","properties":{"partitions":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"replication":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"retention":{"type":"object","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}},"hq_TopicPolicyNaming":{"type":"object","properties":{"pattern":{"type":"string","description":"Regex pattern for topic name validation"},"description":{"type":"string"}}}}}}
```

## The hq\_DataPolicy object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicy":{"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"impactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"}},"versions":{"type":"integer"},"lastUpdated":{"type":"string"},"lastUpdatedUser":{"type":"string"},"impact":{"$ref":"#/components/schemas/hq_DataPolicyImpact"}}},"hq_DataPolicyImpact":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"}},"connectionEntities":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyConnectionEntity"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}}}},"hq_DataPolicyConnectionEntity":{"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyDatasetWithFields"}}}},"hq_DataPolicyDatasetWithFields":{"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}}}},"hq_DataPolicyFieldMatch":{"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DataPolicyAppInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"cluster":{"type":"string"},"namespace":{"type":"string"}}}}}}
```

## The hq\_DataPolicyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyRequest":{"type":"object","required":["name","category","impactType","obfuscation"],"properties":{"name":{"type":"string"},"category":{"type":"string"},"impactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_DataPolicyUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyUpdateRequest":{"type":"object","required":["id","name","category","impactType","obfuscation"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"impactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The hq\_DataPolicyImpact object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyImpact":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"}},"connectionEntities":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyConnectionEntity"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyAppInfo"}}}},"hq_DataPolicyConnectionEntity":{"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyDatasetWithFields"}}}},"hq_DataPolicyDatasetWithFields":{"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}}}},"hq_DataPolicyFieldMatch":{"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"hq_DataPolicyAppInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"cluster":{"type":"string"},"namespace":{"type":"string"}}}}}}
```

## The hq\_DataPolicyConnectionEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyConnectionEntity":{"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyDatasetWithFields"}}}},"hq_DataPolicyDatasetWithFields":{"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}}}},"hq_DataPolicyFieldMatch":{"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_DataPolicyDatasetWithFields object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyDatasetWithFields":{"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/hq_DataPolicyFieldMatch"}}}},"hq_DataPolicyFieldMatch":{"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_DataPolicyFieldMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyFieldMatch":{"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_DataPolicyAppInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DataPolicyAppInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"cluster":{"type":"string"},"namespace":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2":{"type":"object","properties":{"id":{"type":"string"},"application":{"$ref":"#/components/schemas/hq_SQLProcessorV2Application"},"metadata":{"$ref":"#/components/schemas/hq_SQLProcessorV2Metadata"},"deployment":{"$ref":"#/components/schemas/hq_SQLProcessorV2Deployment"},"coverage":{"type":"string","enum":["full","partial"]}}},"hq_SQLProcessorV2Application":{"type":"object","properties":{"name":{"type":"string"},"processorId":{"type":"string"},"lrn":{"type":"string"},"sql":{"type":"string"},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}}}},"hq_SQLProcessorV2Topic":{"type":"object","properties":{"name":{"type":"string"},"keyFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]}}},"hq_SQLProcessorV2Metadata":{"type":"object","properties":{"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"processorType":{"type":"string","enum":["PreDaD","PostDaD"]}}},"hq_SQLProcessorV2Deployment":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentDetails"},"status":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentStatus"}}},"hq_SQLProcessorV2DeploymentDetails":{"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"hq_SQLProcessorV2DeploymentStatus":{"type":"object","properties":{"level":{"type":"string","enum":["NOT_RUNNING","RUNNING","STOPPED","FAILED"]},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2ReplicaStatus"}}}},"hq_SQLProcessorV2ReplicaStatus":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["STOPPED","RUNNING","FAILED"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2Response object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Response":{"type":"object","properties":{"targets":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV1Target"}},"streams":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2"}}}},"hq_SQLProcessorV1Target":{"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}}},"hq_SQLProcessorV2":{"type":"object","properties":{"id":{"type":"string"},"application":{"$ref":"#/components/schemas/hq_SQLProcessorV2Application"},"metadata":{"$ref":"#/components/schemas/hq_SQLProcessorV2Metadata"},"deployment":{"$ref":"#/components/schemas/hq_SQLProcessorV2Deployment"},"coverage":{"type":"string","enum":["full","partial"]}}},"hq_SQLProcessorV2Application":{"type":"object","properties":{"name":{"type":"string"},"processorId":{"type":"string"},"lrn":{"type":"string"},"sql":{"type":"string"},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}}}},"hq_SQLProcessorV2Topic":{"type":"object","properties":{"name":{"type":"string"},"keyFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]}}},"hq_SQLProcessorV2Metadata":{"type":"object","properties":{"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"processorType":{"type":"string","enum":["PreDaD","PostDaD"]}}},"hq_SQLProcessorV2Deployment":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentDetails"},"status":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentStatus"}}},"hq_SQLProcessorV2DeploymentDetails":{"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"hq_SQLProcessorV2DeploymentStatus":{"type":"object","properties":{"level":{"type":"string","enum":["NOT_RUNNING","RUNNING","STOPPED","FAILED"]},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2ReplicaStatus"}}}},"hq_SQLProcessorV2ReplicaStatus":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["STOPPED","RUNNING","FAILED"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2Request object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Request":{"type":"object","required":["name","sql","deployment"],"properties":{"name":{"type":"string","minLength":1},"processorId":{"type":"string","minLength":1},"sql":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"deployment":{"type":"object","properties":{"details":{"type":"object","properties":{"runners":{"type":"integer"},"cluster":{"type":"string"},"namespace":{"type":"string"},"requestedCpu":{"type":"integer"},"limitCpu":{"type":"integer"},"requestedMemory":{"type":"integer"},"limitMemory":{"type":"integer"}}}}},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_SQLProcessorV2Application object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Application":{"type":"object","properties":{"name":{"type":"string"},"processorId":{"type":"string"},"lrn":{"type":"string"},"sql":{"type":"string"},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2Topic"}},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}}}},"hq_SQLProcessorV2Topic":{"type":"object","properties":{"name":{"type":"string"},"keyFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]}}}}}}
```

## The hq\_SQLProcessorV2Metadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Metadata":{"type":"object","properties":{"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"processorType":{"type":"string","enum":["PreDaD","PostDaD"]}}}}}}
```

## The hq\_SQLProcessorV2Deployment object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Deployment":{"type":"object","properties":{"details":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentDetails"},"status":{"$ref":"#/components/schemas/hq_SQLProcessorV2DeploymentStatus"}}},"hq_SQLProcessorV2DeploymentDetails":{"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"hq_SQLProcessorV2DeploymentStatus":{"type":"object","properties":{"level":{"type":"string","enum":["NOT_RUNNING","RUNNING","STOPPED","FAILED"]},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2ReplicaStatus"}}}},"hq_SQLProcessorV2ReplicaStatus":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["STOPPED","RUNNING","FAILED"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2DeploymentDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2DeploymentDetails":{"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"type":"object","additionalProperties":{"type":"string"}},"labels":{"type":"object","additionalProperties":{"type":"string"}},"cluster":{"type":"string"},"namespace":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2DeploymentStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2DeploymentStatus":{"type":"object","properties":{"level":{"type":"string","enum":["NOT_RUNNING","RUNNING","STOPPED","FAILED"]},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV2ReplicaStatus"}}}},"hq_SQLProcessorV2ReplicaStatus":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["STOPPED","RUNNING","FAILED"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2ReplicaStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2ReplicaStatus":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["STOPPED","RUNNING","FAILED"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV2Topic object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV2Topic":{"type":"object","properties":{"name":{"type":"string"},"keyFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueFormat":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]}}}}}}
```

## The hq\_SQLProcessorV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1":{"type":"object","properties":{"user":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string"},"processorId":{"type":"string"},"sql":{"type":"string"},"clusterName":{"type":"string"},"startTs":{"type":"integer"},"namespace":{"type":"string"},"pipeline":{"type":"string"},"runners":{"type":"integer"},"inputTopics":{"type":"array","items":{"type":"string"}},"outputTopics":{"type":"array","items":{"type":"string"}},"state":{"$ref":"#/components/schemas/hq_SQLProcessorV1State"},"upTime":{"type":"integer"},"stopTs":{"type":"integer"},"lastAction":{"$ref":"#/components/schemas/hq_SQLProcessorV1LastAction"},"processorType":{"type":"string","enum":["PreDaD","PostDaD"]},"settings":{"type":"object","additionalProperties":{"type":"string"}},"coverage":{"type":"string","enum":["full","partial"]}}},"hq_SQLProcessorV1State":{"type":"object","properties":{"deploymentStatus":{"type":"string","enum":["FAILED","RUNNING","STOPPED","NOT_RUNNING"]},"deploymentError":{"type":"string"},"runnerStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/hq_SQLProcessorV1RunnerStatus"}}}},"hq_SQLProcessorV1RunnerStatus":{"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"type":"string","enum":["FAILED","RUNNING","STOPPED"]},"errorMsg":{"type":"string"}}},"hq_SQLProcessorV1LastAction":{"type":"object","properties":{"action":{"type":"string","enum":["Scaled","Started","Stopped","Resumed","Created"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV1State object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1State":{"type":"object","properties":{"deploymentStatus":{"type":"string","enum":["FAILED","RUNNING","STOPPED","NOT_RUNNING"]},"deploymentError":{"type":"string"},"runnerStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/hq_SQLProcessorV1RunnerStatus"}}}},"hq_SQLProcessorV1RunnerStatus":{"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"type":"string","enum":["FAILED","RUNNING","STOPPED"]},"errorMsg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV1RunnerStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1RunnerStatus":{"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"type":"string","enum":["FAILED","RUNNING","STOPPED"]},"errorMsg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV1LastAction object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1LastAction":{"type":"object","properties":{"action":{"type":"string","enum":["Scaled","Started","Stopped","Resumed","Created"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV1Request object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1Request":{"type":"object","required":["name","sql","runnerCount"],"properties":{"name":{"type":"string"},"appId":{"type":"string"},"sql":{"type":"string"},"runnerCount":{"type":"integer"},"cluster":{"type":"string"},"namespace":{"type":"string"},"settings":{"type":"object","additionalProperties":{"type":"string"}},"user":{"type":"string"},"pipeline":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorV1Target object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1Target":{"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_SQLProcessorV1ListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorV1ListResponse":{"type":"object","properties":{"targets":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV1Target"}},"streams":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorV1"}}}},"hq_SQLProcessorV1Target":{"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}}},"hq_SQLProcessorV1":{"type":"object","properties":{"user":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string"},"processorId":{"type":"string"},"sql":{"type":"string"},"clusterName":{"type":"string"},"startTs":{"type":"integer"},"namespace":{"type":"string"},"pipeline":{"type":"string"},"runners":{"type":"integer"},"inputTopics":{"type":"array","items":{"type":"string"}},"outputTopics":{"type":"array","items":{"type":"string"}},"state":{"$ref":"#/components/schemas/hq_SQLProcessorV1State"},"upTime":{"type":"integer"},"stopTs":{"type":"integer"},"lastAction":{"$ref":"#/components/schemas/hq_SQLProcessorV1LastAction"},"processorType":{"type":"string","enum":["PreDaD","PostDaD"]},"settings":{"type":"object","additionalProperties":{"type":"string"}},"coverage":{"type":"string","enum":["full","partial"]}}},"hq_SQLProcessorV1State":{"type":"object","properties":{"deploymentStatus":{"type":"string","enum":["FAILED","RUNNING","STOPPED","NOT_RUNNING"]},"deploymentError":{"type":"string"},"runnerStatus":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/hq_SQLProcessorV1RunnerStatus"}}}},"hq_SQLProcessorV1RunnerStatus":{"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"type":"string","enum":["FAILED","RUNNING","STOPPED"]},"errorMsg":{"type":"string"}}},"hq_SQLProcessorV1LastAction":{"type":"object","properties":{"action":{"type":"string","enum":["Scaled","Started","Stopped","Resumed","Created"]},"msg":{"type":"string"}}}}}}
```

## The hq\_SQLProcessorGraph object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorGraph":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"string"}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLProcessorGraphNode"}}}},"hq_SQLProcessorGraphNode":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["STREAM","TABLE","TOPIC"]},"nodeType":{"type":"string","enum":["PreDaDProcessor","PostDaDProcessor","Source","Sink"]},"keyType":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueType":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"children":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_SQLProcessorGraphNode object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorGraphNode":{"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["STREAM","TABLE","TOPIC"]},"nodeType":{"type":"string","enum":["PreDaDProcessor","PostDaDProcessor","Source","Sink"]},"keyType":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"valueType":{"type":"string","enum":["TWAVRO","AVRO","JSON","STRING","INT","LONG","BINARY","PROTOBUF"]},"children":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_SQLProcessorImageRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLProcessorImageRequest":{"type":"object","required":["image"],"properties":{"image":{"type":"string"}}}}}}
```

## The hq\_SQLIntellisenseRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseRequest":{"type":"object","required":["sql","caret"],"properties":{"sql":{"type":"string"},"caret":{"type":"integer"}}}}}}
```

## The hq\_SQLIntellisenseResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseResponse":{"type":"object","properties":{"input":{"type":"string"},"caret":{"type":"integer"},"lints":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLIntellisenseLint"}},"suggestions":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLIntellisenseSuggestion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLIntellisenseHighlight"}},"statementsPositions":{"type":"array","items":{"$ref":"#/components/schemas/hq_SQLIntellisenseStatementPos"}}}},"hq_SQLIntellisenseLint":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string","enum":["Warning","Error","Info"]}}},"hq_SQLIntellisenseSuggestion":{"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}},"hq_SQLIntellisenseHighlight":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string","enum":["Keyword","Identifier","String","Number","Comment","Operator","Function"]}}},"hq_SQLIntellisenseStatementPos":{"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The hq\_SQLIntellisenseSuggestion object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseSuggestion":{"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}}}}}
```

## The hq\_SQLIntellisenseLint object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseLint":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string","enum":["Warning","Error","Info"]}}}}}}
```

## The hq\_SQLIntellisenseHighlight object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseHighlight":{"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"type":"string","enum":["Keyword","Identifier","String","Number","Comment","Operator","Function"]}}}}}}
```

## The hq\_SQLIntellisenseStatementPos object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SQLIntellisenseStatementPos":{"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The hq\_ExternalAppRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppRequest":{"type":"object","required":["name","metadata"],"properties":{"name":{"type":"string","description":"Name should be unique, alphanumeric set of characters"},"metadata":{"$ref":"#/components/schemas/hq_ExternalAppMetadata"},"input":{"type":"array","items":{"$ref":"#/components/schemas/hq_ExternalAppInput"}},"output":{"type":"array","items":{"$ref":"#/components/schemas/hq_ExternalAppOutput"}},"runners":{"type":"array","items":{"$ref":"#/components/schemas/hq_ExternalAppRunner"}}}},"hq_ExternalAppMetadata":{"type":"object","properties":{"version":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"appType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"deployment":{"type":"string"}}},"hq_ExternalAppInput":{"type":"object","properties":{"name":{"type":"string"}}},"hq_ExternalAppOutput":{"type":"object","properties":{"name":{"type":"string"}}},"hq_ExternalAppRunner":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"healthCheckInterval":{"type":"integer"}}}}}}
```

## The hq\_ExternalAppMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppMetadata":{"type":"object","properties":{"version":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"appType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"deployment":{"type":"string"}}}}}}
```

## The hq\_ExternalAppInput object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppInput":{"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The hq\_ExternalAppOutput object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppOutput":{"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The hq\_ExternalAppRunner object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppRunner":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"healthCheckInterval":{"type":"integer"}}}}}}
```

## The hq\_ExternalAppRunnersDeleteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExternalAppRunnersDeleteRequest":{"type":"object","required":["runners"],"properties":{"runners":{"type":"array","minItems":1,"items":{"type":"string"},"description":"A list of runners urls"}}}}}}
```

## The hq\_ApplicationDescriptionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ApplicationDescriptionRequest":{"type":"object","properties":{"description":{"type":"string","minLength":1}}}}}}
```

## The hq\_ApplicationTagsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ApplicationTagsRequest":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_ApplicationTagsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ApplicationTagsResponse":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The hq\_AuditLog object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditLog":{"type":"object","description":"An audit log record.","properties":{"id":{"type":"string","description":"Unique identifier (e.g., aud_xxx)."},"timestamp":{"type":"string","format":"date-time","description":"When the action occurred."},"principal":{"type":"string","description":"Principal name (user or service account)."},"delegation_info":{"$ref":"#/components/schemas/hq_DelegationInfo"},"operation_id":{"type":"string","description":"Operation identifier (e.g., iam:CreateUser)."},"resource_lrn":{"type":"string","description":"LRN of the affected resource (if applicable)."},"request":{"type":"object","additionalProperties":true,"description":"Request body (sensitive data redacted)."},"response":{"type":"object","additionalProperties":true,"description":"Response body (sensitive data redacted)."}},"required":["id","timestamp","principal","operation_id"]},"hq_DelegationInfo":{"description":"Gives information how delegation was done.","oneOf":[{"$ref":"#/components/schemas/hq_OAuth2DelegationInfo"}],"discriminator":{"propertyName":"object_type","mapping":{"oauth2":"#/components/schemas/hq_OAuth2DelegationInfo"}}},"hq_OAuth2DelegationInfo":{"type":"object","properties":{"oauth2_authorization_id":{"type":"string"},"app_name":{"type":"string"},"app_display_name":{"type":"string"}},"required":["oauth2_authorization_id","app_name","app_display_name"]}}}}
```

## The hq\_AuditLogList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_AuditLogList":{"type":"object","description":"Paginated list of audit logs using cursor-based pagination.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_AuditLog"}},"next_cursor":{"type":"string","description":"Opaque cursor for fetching the next page. Absent if no more results."}},"required":["items"]},"hq_AuditLog":{"type":"object","description":"An audit log record.","properties":{"id":{"type":"string","description":"Unique identifier (e.g., aud_xxx)."},"timestamp":{"type":"string","format":"date-time","description":"When the action occurred."},"principal":{"type":"string","description":"Principal name (user or service account)."},"delegation_info":{"$ref":"#/components/schemas/hq_DelegationInfo"},"operation_id":{"type":"string","description":"Operation identifier (e.g., iam:CreateUser)."},"resource_lrn":{"type":"string","description":"LRN of the affected resource (if applicable)."},"request":{"type":"object","additionalProperties":true,"description":"Request body (sensitive data redacted)."},"response":{"type":"object","additionalProperties":true,"description":"Response body (sensitive data redacted)."}},"required":["id","timestamp","principal","operation_id"]},"hq_DelegationInfo":{"description":"Gives information how delegation was done.","oneOf":[{"$ref":"#/components/schemas/hq_OAuth2DelegationInfo"}],"discriminator":{"propertyName":"object_type","mapping":{"oauth2":"#/components/schemas/hq_OAuth2DelegationInfo"}}},"hq_OAuth2DelegationInfo":{"type":"object","properties":{"oauth2_authorization_id":{"type":"string"},"app_name":{"type":"string"},"app_display_name":{"type":"string"}},"required":["oauth2_authorization_id","app_name","app_display_name"]}}}}
```

## The hq\_DelegationInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DelegationInfo":{"description":"Gives information how delegation was done.","oneOf":[{"$ref":"#/components/schemas/hq_OAuth2DelegationInfo"}],"discriminator":{"propertyName":"object_type","mapping":{"oauth2":"#/components/schemas/hq_OAuth2DelegationInfo"}}},"hq_OAuth2DelegationInfo":{"type":"object","properties":{"oauth2_authorization_id":{"type":"string"},"app_name":{"type":"string"},"app_display_name":{"type":"string"}},"required":["oauth2_authorization_id","app_name","app_display_name"]}}}}
```

## The hq\_OAuth2DelegationInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OAuth2DelegationInfo":{"type":"object","properties":{"oauth2_authorization_id":{"type":"string"},"app_name":{"type":"string"},"app_display_name":{"type":"string"}},"required":["oauth2_authorization_id","app_name","app_display_name"]}}}}
```

## The hq\_ExecutedSQLQuery object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExecutedSQLQuery":{"type":"object","description":"A record of a SQL query execution.","properties":{"executed_at":{"type":"string","format":"date-time","description":"When the query was submitted for execution."},"sql":{"type":"string","description":"The executed SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query was executed against.\nThe executed query can outlive the environment, so the data object may\ncontain a name of the environment, that does not exist anymore.\n"}},"required":["executed_at","sql","environment_name"]}}}}
```

## The hq\_CreateExecutedSQLQueryRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateExecutedSQLQueryRequest":{"type":"object","description":"Records a SQL query before execution for the current user.","properties":{"sql":{"type":"string","description":"The SQL statement to execute."},"environment_name":{"type":"string","description":"Name of the environment the query will be executed against."}},"required":["sql","environment_name"]}}}}
```

## The hq\_ExecutedSQLQueryList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ExecutedSQLQueryList":{"type":"object","description":"List of executed SQL queries for the current user.\n","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_ExecutedSQLQuery"}}},"required":["items"]},"hq_ExecutedSQLQuery":{"type":"object","description":"A record of a SQL query execution.","properties":{"executed_at":{"type":"string","format":"date-time","description":"When the query was submitted for execution."},"sql":{"type":"string","description":"The executed SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query was executed against.\nThe executed query can outlive the environment, so the data object may\ncontain a name of the environment, that does not exist anymore.\n"}},"required":["executed_at","sql","environment_name"]}}}}
```

## The hq\_SavedSQLQuery object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SavedSQLQuery":{"type":"object","description":"A SQL query saved by the current user for future execution in SQL Studio.\n","properties":{"name":{"type":"string","format":"hq-resource-name"},"display_name":{"type":"string","description":"User-facing label for the saved query.","minLength":1,"maxLength":150},"sql":{"type":"string","description":"The saved SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query targets. The saved query can outlive\nthe environment, so the data object may contain a name of the environment,\nthat does not exist anymore.\n"},"created_at":{"type":"string","format":"date-time","description":"When the query was first saved."},"updated_at":{"type":"string","format":"date-time","description":"When the query was last modified."}},"required":["name","display_name","sql","environment_name","created_at","updated_at"]}}}}
```

## The hq\_CreateSavedSQLQueryRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_CreateSavedSQLQueryRequest":{"type":"object","description":"Creates a saved SQL query for the current user.","properties":{"name":{"type":"string","format":"hq-resource-name","description":"Sets the name of the new saved SQL query. It must be a valid HQ resource\nname: it can only contain lowercase alphanumeric characters or\nhyphens; hyphens cannot appear at the end or start; the length is 63\ncharacters at most.\n","minLength":1,"maxLength":63},"display_name":{"type":"string","description":"Sets the display name of the saved query. If not provided, the value of\n\"name\" will be used.\n","minLength":1,"maxLength":150},"sql":{"type":"string","description":"The saved SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query targets."}},"required":["name","sql","environment_name"]}}}}
```

## The hq\_UpdateSavedSQLQueryRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_UpdateSavedSQLQueryRequest":{"type":"object","description":"Updates a saved SQL query. Absent fields are left unchanged.\n","properties":{"display_name":{"type":"string","description":"User-facing label for the saved query.","minLength":1,"maxLength":150},"sql":{"type":"string","description":"The saved SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query targets."}}}}}}
```

## The hq\_SavedSQLQueryList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SavedSQLQueryList":{"type":"object","description":"Contains all saved SQL queries for the current user.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_SavedSQLQuery"}}},"required":["items"]},"hq_SavedSQLQuery":{"type":"object","description":"A SQL query saved by the current user for future execution in SQL Studio.\n","properties":{"name":{"type":"string","format":"hq-resource-name"},"display_name":{"type":"string","description":"User-facing label for the saved query.","minLength":1,"maxLength":150},"sql":{"type":"string","description":"The saved SQL statement."},"environment_name":{"type":"string","description":"Name of the environment the query targets. The saved query can outlive\nthe environment, so the data object may contain a name of the environment,\nthat does not exist anymore.\n"},"created_at":{"type":"string","format":"date-time","description":"When the query was first saved."},"updated_at":{"type":"string","format":"date-time","description":"When the query was last modified."}},"required":["name","display_name","sql","environment_name","created_at","updated_at"]}}}}
```

## The hq\_GlobalConsumerGroupState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]}}}}
```

## The hq\_ConsumerGroupLagTrend object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupLagTrend":{"type":"string","description":"Direction of a consumer group partition's lag over the recent window. The value is \"unknown\" until enough samples exist.","enum":["increasing","decreasing","stable","unknown"]}}}}
```

## The hq\_ConsumerGroupCoordinator object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]}}}}
```

## The hq\_ConsumerGroupLagSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupLagSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total offset lag across all partitions. Null when no partition has a computable offset lag (distinct from a genuine zero lag)."},"min":{"type":"integer","format":"int64","description":"Minimum offset lag across partitions. Null when no partition has a computable offset lag."},"min_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the minimum offset lag. Null exactly when min is\nnull (no partition has a computable offset lag). On a tie, the\n(topic, partition) that sorts first.\n"},"max":{"type":"integer","format":"int64","description":"Maximum offset lag across partitions. Null when no partition has a computable offset lag."},"max_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the maximum offset lag. Same nullability and\ntie-breaking rules as min_partition.\n"},"total_ms":{"type":"integer","format":"int64","description":"Total time-based lag in milliseconds. Null when not computable."},"min_ms":{"type":"integer","format":"int64","description":"Minimum time-based lag in milliseconds. Null when not computable."},"max_ms":{"type":"integer","format":"int64","description":"Maximum time-based lag in milliseconds. Null when not computable."}}},"hq_ConsumerGroupPartitionRef":{"type":"object","description":"Identifies a single topic-partition.","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]}}}}
```

## The hq\_ConsumerGroupPartitionRef object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupPartitionRef":{"type":"object","description":"Identifies a single topic-partition.","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]}}}}
```

## The hq\_ConsumerGroupDataFreshness object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]}}}}
```

## The hq\_ConsumerGroup object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroup":{"type":"object","description":"Consumer-group summary at (environment, name) granularity. Used for\nthe environment-scoped list and as the base of ConsumerGroupDetail.\nFor the cross-environment flat grid use ConsumerGroupRow instead.\n","properties":{"environment":{"type":"string","description":"Environment this consumer group belongs to."},"name":{"type":"string","description":"Consumer group ID."},"lrn":{"type":"string","description":"Lenses Resource Name for client-side RBAC. Format:\nkafka:consumer-group:{environment}/kafka/{name}.\n"},"state":{"$ref":"#/components/schemas/hq_GlobalConsumerGroupState"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerGroupCoordinator"},"members_count":{"type":"integer","description":"Number of members in the consumer group."},"topics":{"type":"array","items":{"type":"string"},"description":"Topics subscribed by this consumer group."},"lag":{"$ref":"#/components/schemas/hq_ConsumerGroupLagSummary"},"data_freshness":{"$ref":"#/components/schemas/hq_ConsumerGroupDataFreshness"}},"required":["environment","name","lrn","state","members_count","topics","lag","data_freshness"]},"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]},"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]},"hq_ConsumerGroupLagSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total offset lag across all partitions. Null when no partition has a computable offset lag (distinct from a genuine zero lag)."},"min":{"type":"integer","format":"int64","description":"Minimum offset lag across partitions. Null when no partition has a computable offset lag."},"min_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the minimum offset lag. Null exactly when min is\nnull (no partition has a computable offset lag). On a tie, the\n(topic, partition) that sorts first.\n"},"max":{"type":"integer","format":"int64","description":"Maximum offset lag across partitions. Null when no partition has a computable offset lag."},"max_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the maximum offset lag. Same nullability and\ntie-breaking rules as min_partition.\n"},"total_ms":{"type":"integer","format":"int64","description":"Total time-based lag in milliseconds. Null when not computable."},"min_ms":{"type":"integer","format":"int64","description":"Minimum time-based lag in milliseconds. Null when not computable."},"max_ms":{"type":"integer","format":"int64","description":"Maximum time-based lag in milliseconds. Null when not computable."}}},"hq_ConsumerGroupPartitionRef":{"type":"object","description":"Identifies a single topic-partition.","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]},"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]}}}}
```

## The hq\_ConsumerGroupMember object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupMember":{"type":"object","description":"Per-member view of a consumer group. Each member is a single consumer\nprocess currently joined to the group, with the membership details the\nbroker reports.\n","properties":{"consumer_id":{"type":"string","description":"Unique consumer member ID within the group."},"client_id":{"type":"string","description":"Client ID of the consumer."},"host":{"type":"string","description":"Host of the consumer."},"group_instance_id":{"type":"string","description":"Static membership instance id assigned to the consumer. Absent for\ndynamic members that do not use static membership.\n"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroupMemberAssignment"},"description":"Topic-partition assignments for this member."}},"required":["consumer_id","client_id","host","assignments"]},"hq_ConsumerGroupMemberAssignment":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]}}}}
```

## The hq\_ConsumerGroupMemberAssignment object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupMemberAssignment":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]}}}}
```

## The hq\_ConsumerGroupTopicPartition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupTopicPartition":{"type":"object","description":"Per-(group, topic, partition) row combining committed offset and\npartition log position data. Used both as the building block of the\nflat grid (see ConsumerGroupRow) and as the partition-level detail\nnested under ConsumerGroupDetail.\n","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."},"current_offset":{"type":"integer","format":"int64","description":"Current committed offset for this group, topic and partition.\nAbsent if no offset has been committed.\n"},"start_offset":{"type":"integer","format":"int64","description":"Earliest available offset for the partition (log start)."},"log_end_offset":{"type":"integer","format":"int64","description":"Log-end offset for the partition (latest)."},"lag":{"type":"integer","format":"int64","description":"Offset lag (log_end_offset - current_offset)."},"lag_ms":{"type":"integer","format":"int64","description":"Estimated time-based lag in milliseconds (offset lag divided by\nthe producer rate over a sliding window). Approximates how far\nbehind in time the consumer is. Matches the agent's lag_ms.\nAbsent when the producer rate is unavailable (idle topic or\ninsufficient samples).\n"},"lag_catch_up_ms":{"type":"integer","format":"int64","description":"Estimated milliseconds for the lag to reach zero at the current\nnet consumption rate. Absent when the consumer is not gaining\n(lag flat or growing) or history is insufficient.\n"},"lag_trend":{"$ref":"#/components/schemas/hq_ConsumerGroupLagTrend"},"leader_epoch":{"type":"integer","format":"int32","description":"Leader epoch of the committed offset. Absent when not recorded.\n"},"metadata":{"type":"string","description":"Committed-offset metadata string. May be empty.\n"},"consumer_id":{"type":"string","description":"Consumer member assigned to this partition (if any). Sourced from\nConsumerGroupMember.assignments by HQ during grid assembly.\n"}},"required":["topic","partition"]},"hq_ConsumerGroupLagTrend":{"type":"string","description":"Direction of a consumer group partition's lag over the recent window. The value is \"unknown\" until enough samples exist.","enum":["increasing","decreasing","stable","unknown"]}}}}
```

## The hq\_ConsumerGroupRow object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupRow":{"type":"object","description":"One row of the cross-environment flat grid keyed by\n(environment, consumer_group, topic, partition).\n\nEach row carries per-partition offsets/lag plus per-group context\n(state, coordinator, lrn, freshness) sufficient to be rendered and\nfiltered independently.\n","properties":{"environment":{"type":"string","description":"Environment this row belongs to."},"consumer_group":{"type":"string","description":"Consumer group ID."},"lrn":{"type":"string","description":"Lenses Resource Name for client-side RBAC. Format:\nkafka:consumer-group:{environment}/kafka/{consumer_group}.\n"},"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."},"state":{"$ref":"#/components/schemas/hq_GlobalConsumerGroupState"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerGroupCoordinator"},"members_count":{"type":"integer","description":"Number of members in the consumer group."},"consumer_id":{"type":"string","description":"Consumer member assigned to this partition (if any)."},"current_offset":{"type":"integer","format":"int64","description":"Current committed offset. Absent if no committed offset."},"start_offset":{"type":"integer","format":"int64","description":"Earliest available offset for the partition."},"log_end_offset":{"type":"integer","format":"int64","description":"Log-end offset for the partition."},"lag":{"type":"integer","format":"int64","description":"Offset lag (log_end_offset - current_offset)."},"lag_ms":{"type":"integer","format":"int64","nullable":true,"description":"Estimated time-based lag in milliseconds (offset lag divided by\nthe producer rate over a sliding window). Approximates how far\nbehind in time the consumer is. Matches the agent's lag_ms. Null\nwhen the producer rate is unavailable (idle topic or insufficient\nsamples); 0 means caught up.\n"},"lag_catch_up_ms":{"type":"integer","format":"int64","nullable":true,"description":"Estimated milliseconds for the lag to reach zero at the current\nnet consumption rate. Null when the consumer is not gaining (lag\nflat or growing) or history is insufficient.\n"},"lag_trend":{"$ref":"#/components/schemas/hq_ConsumerGroupLagTrend"},"leader_epoch":{"type":"integer","format":"int32","description":"Leader epoch of the committed offset (optional)."},"metadata":{"type":"string","description":"Committed-offset metadata string (may be empty)."},"data_freshness":{"$ref":"#/components/schemas/hq_ConsumerGroupDataFreshness"}},"required":["environment","consumer_group","lrn","topic","partition","state","members_count","lag_ms","lag_catch_up_ms","data_freshness"]},"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]},"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]},"hq_ConsumerGroupLagTrend":{"type":"string","description":"Direction of a consumer group partition's lag over the recent window. The value is \"unknown\" until enough samples exist.","enum":["increasing","decreasing","stable","unknown"]},"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]}}}}
```

## The hq\_ConsumerGroupDetail object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupDetail":{"description":"Full per-group detail including member-level information and\nper-partition offset data (nested as topic_partitions).\n","allOf":[{"$ref":"#/components/schemas/hq_ConsumerGroup"},{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroupMember"},"description":"Members of the consumer group."},"topic_partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroupTopicPartition"},"description":"Topic-partition details with offsets and lag."}},"required":["members","topic_partitions"]}]},"hq_ConsumerGroup":{"type":"object","description":"Consumer-group summary at (environment, name) granularity. Used for\nthe environment-scoped list and as the base of ConsumerGroupDetail.\nFor the cross-environment flat grid use ConsumerGroupRow instead.\n","properties":{"environment":{"type":"string","description":"Environment this consumer group belongs to."},"name":{"type":"string","description":"Consumer group ID."},"lrn":{"type":"string","description":"Lenses Resource Name for client-side RBAC. Format:\nkafka:consumer-group:{environment}/kafka/{name}.\n"},"state":{"$ref":"#/components/schemas/hq_GlobalConsumerGroupState"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerGroupCoordinator"},"members_count":{"type":"integer","description":"Number of members in the consumer group."},"topics":{"type":"array","items":{"type":"string"},"description":"Topics subscribed by this consumer group."},"lag":{"$ref":"#/components/schemas/hq_ConsumerGroupLagSummary"},"data_freshness":{"$ref":"#/components/schemas/hq_ConsumerGroupDataFreshness"}},"required":["environment","name","lrn","state","members_count","topics","lag","data_freshness"]},"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]},"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]},"hq_ConsumerGroupLagSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total offset lag across all partitions. Null when no partition has a computable offset lag (distinct from a genuine zero lag)."},"min":{"type":"integer","format":"int64","description":"Minimum offset lag across partitions. Null when no partition has a computable offset lag."},"min_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the minimum offset lag. Null exactly when min is\nnull (no partition has a computable offset lag). On a tie, the\n(topic, partition) that sorts first.\n"},"max":{"type":"integer","format":"int64","description":"Maximum offset lag across partitions. Null when no partition has a computable offset lag."},"max_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the maximum offset lag. Same nullability and\ntie-breaking rules as min_partition.\n"},"total_ms":{"type":"integer","format":"int64","description":"Total time-based lag in milliseconds. Null when not computable."},"min_ms":{"type":"integer","format":"int64","description":"Minimum time-based lag in milliseconds. Null when not computable."},"max_ms":{"type":"integer","format":"int64","description":"Maximum time-based lag in milliseconds. Null when not computable."}}},"hq_ConsumerGroupPartitionRef":{"type":"object","description":"Identifies a single topic-partition.","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]},"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]},"hq_ConsumerGroupMember":{"type":"object","description":"Per-member view of a consumer group. Each member is a single consumer\nprocess currently joined to the group, with the membership details the\nbroker reports.\n","properties":{"consumer_id":{"type":"string","description":"Unique consumer member ID within the group."},"client_id":{"type":"string","description":"Client ID of the consumer."},"host":{"type":"string","description":"Host of the consumer."},"group_instance_id":{"type":"string","description":"Static membership instance id assigned to the consumer. Absent for\ndynamic members that do not use static membership.\n"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroupMemberAssignment"},"description":"Topic-partition assignments for this member."}},"required":["consumer_id","client_id","host","assignments"]},"hq_ConsumerGroupMemberAssignment":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]},"hq_ConsumerGroupTopicPartition":{"type":"object","description":"Per-(group, topic, partition) row combining committed offset and\npartition log position data. Used both as the building block of the\nflat grid (see ConsumerGroupRow) and as the partition-level detail\nnested under ConsumerGroupDetail.\n","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."},"current_offset":{"type":"integer","format":"int64","description":"Current committed offset for this group, topic and partition.\nAbsent if no offset has been committed.\n"},"start_offset":{"type":"integer","format":"int64","description":"Earliest available offset for the partition (log start)."},"log_end_offset":{"type":"integer","format":"int64","description":"Log-end offset for the partition (latest)."},"lag":{"type":"integer","format":"int64","description":"Offset lag (log_end_offset - current_offset)."},"lag_ms":{"type":"integer","format":"int64","description":"Estimated time-based lag in milliseconds (offset lag divided by\nthe producer rate over a sliding window). Approximates how far\nbehind in time the consumer is. Matches the agent's lag_ms.\nAbsent when the producer rate is unavailable (idle topic or\ninsufficient samples).\n"},"lag_catch_up_ms":{"type":"integer","format":"int64","description":"Estimated milliseconds for the lag to reach zero at the current\nnet consumption rate. Absent when the consumer is not gaining\n(lag flat or growing) or history is insufficient.\n"},"lag_trend":{"$ref":"#/components/schemas/hq_ConsumerGroupLagTrend"},"leader_epoch":{"type":"integer","format":"int32","description":"Leader epoch of the committed offset. Absent when not recorded.\n"},"metadata":{"type":"string","description":"Committed-offset metadata string. May be empty.\n"},"consumer_id":{"type":"string","description":"Consumer member assigned to this partition (if any). Sourced from\nConsumerGroupMember.assignments by HQ during grid assembly.\n"}},"required":["topic","partition"]},"hq_ConsumerGroupLagTrend":{"type":"string","description":"Direction of a consumer group partition's lag over the recent window. The value is \"unknown\" until enough samples exist.","enum":["increasing","decreasing","stable","unknown"]}}}}
```

## The hq\_ConsumerGroupList object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupList":{"type":"object","description":"Paginated list of consumer groups at (env, group) granularity, using\ncursor-based pagination. Complements ConsumerGroupGrid for\nenvironment-scoped sidebar views where per-partition rows are not needed.\n","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroup"}},"next_cursor":{"type":"string","description":"Opaque cursor for fetching the next page. Absent if no more results."}},"required":["items"]},"hq_ConsumerGroup":{"type":"object","description":"Consumer-group summary at (environment, name) granularity. Used for\nthe environment-scoped list and as the base of ConsumerGroupDetail.\nFor the cross-environment flat grid use ConsumerGroupRow instead.\n","properties":{"environment":{"type":"string","description":"Environment this consumer group belongs to."},"name":{"type":"string","description":"Consumer group ID."},"lrn":{"type":"string","description":"Lenses Resource Name for client-side RBAC. Format:\nkafka:consumer-group:{environment}/kafka/{name}.\n"},"state":{"$ref":"#/components/schemas/hq_GlobalConsumerGroupState"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerGroupCoordinator"},"members_count":{"type":"integer","description":"Number of members in the consumer group."},"topics":{"type":"array","items":{"type":"string"},"description":"Topics subscribed by this consumer group."},"lag":{"$ref":"#/components/schemas/hq_ConsumerGroupLagSummary"},"data_freshness":{"$ref":"#/components/schemas/hq_ConsumerGroupDataFreshness"}},"required":["environment","name","lrn","state","members_count","topics","lag","data_freshness"]},"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]},"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]},"hq_ConsumerGroupLagSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total offset lag across all partitions. Null when no partition has a computable offset lag (distinct from a genuine zero lag)."},"min":{"type":"integer","format":"int64","description":"Minimum offset lag across partitions. Null when no partition has a computable offset lag."},"min_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the minimum offset lag. Null exactly when min is\nnull (no partition has a computable offset lag). On a tie, the\n(topic, partition) that sorts first.\n"},"max":{"type":"integer","format":"int64","description":"Maximum offset lag across partitions. Null when no partition has a computable offset lag."},"max_partition":{"$ref":"#/components/schemas/hq_ConsumerGroupPartitionRef","description":"The partition with the maximum offset lag. Same nullability and\ntie-breaking rules as min_partition.\n"},"total_ms":{"type":"integer","format":"int64","description":"Total time-based lag in milliseconds. Null when not computable."},"min_ms":{"type":"integer","format":"int64","description":"Minimum time-based lag in milliseconds. Null when not computable."},"max_ms":{"type":"integer","format":"int64","description":"Maximum time-based lag in milliseconds. Null when not computable."}}},"hq_ConsumerGroupPartitionRef":{"type":"object","description":"Identifies a single topic-partition.","properties":{"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."}},"required":["topic","partition"]},"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]}}}}
```

## The hq\_ConsumerGroupGrid object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConsumerGroupGrid":{"type":"object","description":"Paginated flat grid of consumer-group rows keyed by\n(environment, consumer_group, topic, partition). Sorting and filtering\noperate on individual grid cells (e.g. \"sort by partition lag desc\").\n","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConsumerGroupRow"}},"next_cursor":{"type":"string","description":"Opaque cursor for fetching the next page. Absent if no more results."}},"required":["items"]},"hq_ConsumerGroupRow":{"type":"object","description":"One row of the cross-environment flat grid keyed by\n(environment, consumer_group, topic, partition).\n\nEach row carries per-partition offsets/lag plus per-group context\n(state, coordinator, lrn, freshness) sufficient to be rendered and\nfiltered independently.\n","properties":{"environment":{"type":"string","description":"Environment this row belongs to."},"consumer_group":{"type":"string","description":"Consumer group ID."},"lrn":{"type":"string","description":"Lenses Resource Name for client-side RBAC. Format:\nkafka:consumer-group:{environment}/kafka/{consumer_group}.\n"},"topic":{"type":"string","description":"Topic name."},"partition":{"type":"integer","minimum":0,"description":"Partition number."},"state":{"$ref":"#/components/schemas/hq_GlobalConsumerGroupState"},"coordinator":{"$ref":"#/components/schemas/hq_ConsumerGroupCoordinator"},"members_count":{"type":"integer","description":"Number of members in the consumer group."},"consumer_id":{"type":"string","description":"Consumer member assigned to this partition (if any)."},"current_offset":{"type":"integer","format":"int64","description":"Current committed offset. Absent if no committed offset."},"start_offset":{"type":"integer","format":"int64","description":"Earliest available offset for the partition."},"log_end_offset":{"type":"integer","format":"int64","description":"Log-end offset for the partition."},"lag":{"type":"integer","format":"int64","description":"Offset lag (log_end_offset - current_offset)."},"lag_ms":{"type":"integer","format":"int64","nullable":true,"description":"Estimated time-based lag in milliseconds (offset lag divided by\nthe producer rate over a sliding window). Approximates how far\nbehind in time the consumer is. Matches the agent's lag_ms. Null\nwhen the producer rate is unavailable (idle topic or insufficient\nsamples); 0 means caught up.\n"},"lag_catch_up_ms":{"type":"integer","format":"int64","nullable":true,"description":"Estimated milliseconds for the lag to reach zero at the current\nnet consumption rate. Null when the consumer is not gaining (lag\nflat or growing) or history is insufficient.\n"},"lag_trend":{"$ref":"#/components/schemas/hq_ConsumerGroupLagTrend"},"leader_epoch":{"type":"integer","format":"int32","description":"Leader epoch of the committed offset (optional)."},"metadata":{"type":"string","description":"Committed-offset metadata string (may be empty)."},"data_freshness":{"$ref":"#/components/schemas/hq_ConsumerGroupDataFreshness"}},"required":["environment","consumer_group","lrn","topic","partition","state","members_count","lag_ms","lag_catch_up_ms","data_freshness"]},"hq_GlobalConsumerGroupState":{"type":"string","description":"Consumer group state. Kafka's consumer group states are collapsed into five values: stable (STABLE); rebalancing (PREPARING_REBALANCE, COMPLETING_REBALANCE, and the consumer-protocol rebalance phases ASSIGNING and RECONCILING); empty (EMPTY); dead (DEAD); and unknown (when the broker reports no state, or the value is not recognised).","enum":["stable","rebalancing","empty","dead","unknown"]},"hq_ConsumerGroupCoordinator":{"type":"object","properties":{"id":{"type":"integer","description":"Broker ID of the coordinator."},"host":{"type":"string","description":"Hostname of the coordinator."},"port":{"type":"integer","description":"Port of the coordinator."},"rack":{"type":"string","description":"Rack of the coordinator."}},"required":["id","host","port"]},"hq_ConsumerGroupLagTrend":{"type":"string","description":"Direction of a consumer group partition's lag over the recent window. The value is \"unknown\" until enough samples exist.","enum":["increasing","decreasing","stable","unknown"]},"hq_ConsumerGroupDataFreshness":{"type":"object","description":"Freshness metadata for this consumer group entry, indicating when the\ndata was last successfully retrieved and whether a retrieval error was\nencountered.\n","properties":{"last_retrieved_at":{"type":"string","format":"date-time","description":"Timestamp of the last successful data retrieval for this row.\nNot advanced on failed attempts.\n"},"stale":{"type":"boolean","description":"True if the most recent refresh attempt for this row failed\n(agent unreachable, gRPC timeout, RBAC error). The row's other\nfields still reflect the last successful retrieval at\nlast_retrieved_at, but the UI should surface a \"data may be\noutdated\" indicator. False on success.\n"},"refresh_interval_seconds":{"type":"integer","description":"Configured background-refresh interval in seconds. UI hint for\nrendering staleness indicators.\n"}},"required":["last_retrieved_at","stale"]}}}}
```

## The hq\_PartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_PartitionOffset":{"type":"object","properties":{"partition":{"type":"integer","minimum":0,"description":"Partition number."},"offset":{"type":"integer","format":"int64","minimum":0,"description":"Target offset. Required when type is absolute."}},"required":["partition"]}}}}
```

## The hq\_TopicPartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPartitionOffset":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_PartitionOffset"},"minItems":1,"description":"Partitions to set offsets for. At least one partition must be listed per topic; partition discovery (\"apply to all partitions\") is not yet supported on the set-offsets path."}},"required":["topic","partitions"]},"hq_PartitionOffset":{"type":"object","properties":{"partition":{"type":"integer","minimum":0,"description":"Partition number."},"offset":{"type":"integer","format":"int64","minimum":0,"description":"Target offset. Required when type is absolute."}},"required":["partition"]}}}}
```

## The hq\_OffsetResetType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_OffsetResetType":{"type":"string","description":"Reset strategy for the offsets.","enum":["earliest","latest","timestamp","absolute"]}}}}
```

## The hq\_SetConsumerGroupOffsetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_SetConsumerGroupOffsetsRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/hq_OffsetResetType"},"timestamp":{"type":"string","format":"date-time","description":"Target timestamp. Required when type is timestamp."},"topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_TopicPartitionOffset"},"minItems":1,"description":"Topics and partitions to set offsets for."}},"required":["type","topics"]},"hq_OffsetResetType":{"type":"string","description":"Reset strategy for the offsets.","enum":["earliest","latest","timestamp","absolute"]},"hq_TopicPartitionOffset":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/hq_PartitionOffset"},"minItems":1,"description":"Partitions to set offsets for. At least one partition must be listed per topic; partition discovery (\"apply to all partitions\") is not yet supported on the set-offsets path."}},"required":["topic","partitions"]},"hq_PartitionOffset":{"type":"object","properties":{"partition":{"type":"integer","minimum":0,"description":"Partition number."},"offset":{"type":"integer","format":"int64","minimum":0,"description":"Target offset. Required when type is absolute."}},"required":["partition"]}}}}
```

## The hq\_TopicPartitions object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TopicPartitions":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partitions":{"type":"array","items":{"type":"integer","minimum":0},"description":"Partition numbers. If omitted, applies to all partitions of the topic."}},"required":["topic"]}}}}
```

## The hq\_DeleteConsumerGroupOffsetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_DeleteConsumerGroupOffsetsRequest":{"type":"object","description":"Selects which committed offsets to delete. Omit topics or pass an\nempty array to delete all committed offsets for the group. Each entry\nmay omit partitions to delete every partition the group consumes on\nthat topic, or list partitions for topic-partition scope. The group\nmust be inactive. Irreversible.\n","properties":{"topics":{"type":"array","items":{"$ref":"#/components/schemas/hq_TopicPartitions"},"description":"Topics and partitions to delete offsets for."}}},"hq_TopicPartitions":{"type":"object","properties":{"topic":{"type":"string","description":"Topic name."},"partitions":{"type":"array","items":{"type":"integer","minimum":0},"description":"Partition numbers. If omitted, applies to all partitions of the topic."}},"required":["topic"]}}}}
```

## The hq\_ConnectorStateSet object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectorStateSet":{"type":"string","enum":["start","stop","restart","pause","resume"],"description":"Connector state actions"}}}}
```

## The hq\_HttpNewConnector object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpNewConnector":{"type":"object","required":["name","cluster","configuration"],"properties":{"name":{"type":"string","description":"The connector name"},"cluster":{"type":"string","description":"The Connect cluster name"},"configuration":{"type":"object","additionalProperties":{"type":"string"},"description":"Connector configuration properties"}}}}}}
```

## The hq\_HttpValidateConnector object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpValidateConnector":{"type":"object","required":["name","cluster","configuration"],"properties":{"name":{"type":"string","description":"The connector name"},"cluster":{"type":"string","description":"The Connect cluster name"},"configuration":{"type":"object","additionalProperties":{"type":"string"},"description":"Connector configuration properties to validate"}}}}}}
```

## The hq\_HttpDataResponse\_HttpConnectorListItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpDataResponse_HttpConnectorListItem":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/hq_HttpConnectorListItem"}}}},"hq_HttpConnectorListItem":{"type":"object","required":["name","cluster"],"properties":{"name":{"type":"string"},"cluster":{"type":"string"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/hq_HttpSimpleTaskItem"}},"className":{"type":"string"},"type":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"}}},"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"hq_HttpSimpleTaskItem":{"type":"object","required":["id","state"],"properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"}}}}}}
```

## The hq\_HttpConnectorListItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpConnectorListItem":{"type":"object","required":["name","cluster"],"properties":{"name":{"type":"string"},"cluster":{"type":"string"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/hq_HttpSimpleTaskItem"}},"className":{"type":"string"},"type":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"}}},"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"hq_HttpSimpleTaskItem":{"type":"object","required":["id","state"],"properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"}}}}}}
```

## The hq\_HttpSimpleTaskItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpSimpleTaskItem":{"type":"object","required":["id","state"],"properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"}}},"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]}}}}
```

## The hq\_ConnectStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]}}}}
```

## The hq\_HttpConnectorDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpConnectorDetails":{"type":"object","required":["name","cluster"],"properties":{"name":{"type":"string"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"},"type":{"type":"string"},"className":{"type":"string"},"workerId":{"type":"string"},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"cluster":{"type":"string"},"config":{"type":"object","additionalProperties":{"type":"string"}},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/hq_TaskDetails"}},"code":{"type":"string","description":"YAML representation of the connector resource"}}},"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"hq_TaskDetails":{"type":"object","required":["id","state","workerId"],"properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"},"workerId":{"type":"string"},"trace":{"type":"string","description":"Error trace if task is in FAILED state"}}}}}}
```

## The hq\_TaskDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_TaskDetails":{"type":"object","required":["id","state","workerId"],"properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/hq_ConnectStatus"},"workerId":{"type":"string"},"trace":{"type":"string","description":"Error trace if task is in FAILED state"}}},"hq_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]}}}}
```

## The hq\_HttpConnectorValidationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpConnectorValidationResponse":{"type":"object","properties":{"class":{"type":"string","description":"The connector class name"},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/hq_HttpConnectorValidationField"}}}},"hq_HttpConnectorValidationField":{"type":"object","required":["name","required","order","documentation","visible"],"properties":{"name":{"type":"string"},"required":{"type":"boolean"},"order":{"type":"integer"},"documentation":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"visible":{"type":"boolean"}}}}}}
```

## The hq\_HttpConnectorValidationField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpConnectorValidationField":{"type":"object","required":["name","required","order","documentation","visible"],"properties":{"name":{"type":"string"},"required":{"type":"boolean"},"order":{"type":"integer"},"documentation":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"visible":{"type":"boolean"}}}}}}
```

## The hq\_HttpDataResponse\_HttpConnectPluginItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpDataResponse_HttpConnectPluginItem":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/hq_HttpConnectPluginItem"}}}},"hq_HttpConnectPluginItem":{"type":"object","required":["class","cluster","type","version"],"properties":{"class":{"type":"string"},"cluster":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["sink","source"]},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"}}}}}}
```

## The hq\_HttpConnectPluginItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpConnectPluginItem":{"type":"object","required":["class","cluster","type","version"],"properties":{"class":{"type":"string"},"cluster":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["sink","source"]},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"}}}}}}
```

## The hq\_ConnectInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectInfo":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string"},"version":{"type":"string"}}}}}}
```

## The hq\_ConnectorOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectorOffsetsResponse":{"type":"object","description":"Offset information for a connector (KIP-875)","properties":{"offsets":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConnectorOffset"}}}},"hq_ConnectorOffset":{"type":"object","properties":{"partition":{"type":"object","additionalProperties":true},"offset":{"type":"object","additionalProperties":true}}}}}}
```

## The hq\_ConnectorOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectorOffset":{"type":"object","properties":{"partition":{"type":"object","additionalProperties":true},"offset":{"type":"object","additionalProperties":true}}}}}}
```

## The hq\_ConnectorOffsetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectorOffsetsRequest":{"type":"object","required":["offsets"],"properties":{"offsets":{"type":"array","items":{"$ref":"#/components/schemas/hq_ConnectorOffset"}}}},"hq_ConnectorOffset":{"type":"object","properties":{"partition":{"type":"object","additionalProperties":true},"offset":{"type":"object","additionalProperties":true}}}}}}
```

## The hq\_HttpAlterOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_HttpAlterOffsetsResponse":{"type":"object","properties":{"message":{"type":"string"}}}}}}
```

## The hq\_ConnectorResourceJsonSchema object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"hq_ConnectorResourceJsonSchema":{"type":"object","description":"JSON Schema for connector resource validation","properties":{"$schema":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"properties":{"type":"object","additionalProperties":true}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration"}}},"agent_AWSGlueSchemaRegistryConnectionConfiguration":{"required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"type":"integer"},"glueRegistryDefaultCompatibility":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfigurationV2"}}},"agent_AWSGlueSchemaRegistryConnectionConfigurationV2":{"required":["authMode","glueRegistryArn"],"type":"object","properties":{"accessKeyId":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Access key ID of an AWS IAM account"},"secretAccessKey":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Secret access key of an AWS IAM account"},"sessionToken":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations"},"authMode":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Way to authenticate against AWS"},"assumeRoleArn":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"},"assumeRoleSessionName":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"},"glueRegistryArn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}}},"glueRegistryDefaultCompatibility":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionConfiguration":{"required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"type":"integer"},"glueRegistryDefaultCompatibility":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionConfigurationV2":{"required":["authMode","glueRegistryArn"],"type":"object","properties":{"accessKeyId":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Access key ID of an AWS IAM account"},"secretAccessKey":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Secret access key of an AWS IAM account"},"sessionToken":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations"},"authMode":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Way to authenticate against AWS"},"assumeRoleArn":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"},"assumeRoleSessionName":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"},"glueRegistryArn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}}},"glueRegistryDefaultCompatibility":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_AWSGlueSchemaRegistryConnectionConfiguration":{"required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"type":"integer"},"glueRegistryDefaultCompatibility":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_AWSGlueSchemaRegistryConnectionConfiguration":{"required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"type":"integer"},"glueRegistryDefaultCompatibility":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_AWSGlueSchemaRegistryConnectionConfigurationV2":{"required":["authMode","glueRegistryArn"],"type":"object","properties":{"accessKeyId":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Access key ID of an AWS IAM account"},"secretAccessKey":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Secret access key of an AWS IAM account"},"sessionToken":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations"},"authMode":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Way to authenticate against AWS"},"assumeRoleArn":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"},"assumeRoleSessionName":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"},"glueRegistryArn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}}},"glueRegistryDefaultCompatibility":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration"}}},"agent_AWSGlueSchemaRegistryConnectionConfiguration":{"required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"type":"integer"},"glueRegistryDefaultCompatibility":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}
```

## The agent\_AWSGlueSchemaRegistryConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSGlueSchemaRegistryConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfigurationV2"}}},"agent_AWSGlueSchemaRegistryConnectionConfigurationV2":{"required":["authMode","glueRegistryArn"],"type":"object","properties":{"accessKeyId":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Access key ID of an AWS IAM account"},"secretAccessKey":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Secret access key of an AWS IAM account"},"sessionToken":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations"},"authMode":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"Way to authenticate against AWS"},"assumeRoleArn":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"},"assumeRoleSessionName":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string"}},"description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"},"glueRegistryArn":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."},"glueRegistryCacheTtl":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue."},"glueRegistryCacheSize":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}}},"glueRegistryDefaultCompatibility":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}}}}}}}
```

## The agent\_Absolute object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Absolute":{"required":["offset"],"type":"object","properties":{"offset":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Acl object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Acl":{"required":["resourceType","resourceName","principal","permissionType","host","operation"],"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"},"patternType":{"type":"string"},"principal":{"type":"string"},"permissionType":{"type":"string"},"host":{"type":"string"},"operation":{"type":"string"}}}}}}
```

## The agent\_AddConnectionApiRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AddConnectionApiRequestV2":{"required":["name","templateName"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection","minLength":1},"configuration":{"type":"object","description":"The configuration of the connection. The schema of this object is defined by the [template configuration](#operation/listConnectionTemplates)"}}}}}}
```

## The agent\_AddConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AddConnectionResponse":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"}}}}}}
```

## The agent\_AlertConditionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertConditionRequest":{"required":["condition"],"type":"object","properties":{"condition":{"oneOf":[{"$ref":"#/components/schemas/agent_JsonObject"},{"type":"string"}]},"channels":{"type":"array","items":{"type":"string"}}}},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_AlertConditionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertConditionResponse":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The agent\_AlertRuleDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertRuleDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_ConditionalAlertRuleDetails"},{"$ref":"#/components/schemas/agent_FixedAlertRuleDetails"}]},"agent_ConditionalAlertRuleDetails":{"required":["conditions","alertType"],"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/agent_Map_UUID_ConditionDetails"},"alertType":{"$ref":"#/components/schemas/agent_AlertType"}}},"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]},"agent_FixedAlertRuleDetails":{"required":["alertType","modifiedBy","modifiedAt"],"type":"object","properties":{"alertType":{"$ref":"#/components/schemas/agent_AlertType"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}}}}}
```

## The agent\_AlertSetting object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertSetting":{"type":"integer","enum":[1000,1001,1002,1003,1005,1006,1007,1008,1009,1010,1011,1012,1013,1014,2000,3000,4000,4001,4002,5000,6000]}}}}
```

## The agent\_AlertSettingPatchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertSettingPatchRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"channels":{"type":"array","items":{"type":"string"}},"config":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_AlertSettingPutRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertSettingPutRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean"},"channels":{"type":"array","items":{"type":"string"}},"config":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_AlertSettingResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertSettingResponse":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}}}}}}
```

## The agent\_AlertType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]}}}}
```

## The agent\_AppMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AppMetadata":{"type":"object","properties":{"version":{"type":"string","description":"version of the app"},"description":{"type":"string","description":"description of the app"},"owner":{"type":"string","description":"name of the owner of the app"},"appType":{"type":"string","description":"type of the app"},"tags":{"type":"array","items":{"type":"string"},"description":"a set of unique strings"},"deployment":{"type":"string","description":"deployment of the app"}}}}}}
```

## The agent\_AppState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AppState":{"required":["deploymentStatus","runnerStatus"],"type":"object","properties":{"deploymentStatus":{"$ref":"#/components/schemas/agent_AppStateEnum"},"deploymentError":{"type":"string"},"runnerStatus":{"$ref":"#/components/schemas/agent_Map_String_Runner"}}},"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]},"agent_Map_String_Runner":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_Runner1"}},"agent_Runner1":{"required":["id","worker","status"],"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_AppStateEnum"},"errorMsg":{"type":"string"}}}}}}
```

## The agent\_AppStateEnum object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]}}}}
```

## The agent\_Application object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The agent\_ApplicationInputOutputEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApplicationInputOutputEntry":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Node Name"}}}}}}
```

## The agent\_ApplicationTagsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApplicationTagsResponse":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string","minLength":1}}}}}}}
```

## The agent\_ApplicationType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The agent\_ApplyPresetResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApplyPresetResponse":{"required":["preset","loggersReset"],"type":"object","properties":{"preset":{"type":"string"},"previousPreset":{"type":"string"},"loggersReset":{"type":"integer"}}}}}}
```

## The agent\_ApprovalRequestField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApprovalRequestField":{"type":"string","enum":["entityName","createdBy","createdAt"]}}}}
```

## The agent\_ApprovalStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ApprovalStatus":{"type":"string","enum":["Approved","Pending","Rejected","Failed"]}}}}
```

## The agent\_Audit object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Audit":{"required":["type","action","user","timestamp","content"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/agent_AuditResource"},"action":{"$ref":"#/components/schemas/agent_AuditChange"},"user":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"content":{"$ref":"#/components/schemas/agent_Map_String_String"}}},"agent_AuditResource":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]},"agent_AuditChange":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_AuditChange object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AuditChange":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]}}}}
```

## The agent\_AuditMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AuditMetadata":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/agent_AuditChange"}},"types":{"type":"array","items":{"$ref":"#/components/schemas/agent_AuditResource"}}}},"agent_AuditChange":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]},"agent_AuditResource":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]}}}}
```

## The agent\_AuditResource object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AuditResource":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]}}}}
```

## The agent\_Backup object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Backup":{"type":"object"}}}}
```

## The agent\_BackupFlushSettings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupFlushSettings":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"interval":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_BackupRestore object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupRestore":{"type":"object"}}}}
```

## The agent\_BackupRestoreItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupRestoreItem":{"required":["id","createdAt","type","topic","connectCluster","connectorName","connectorVersion","s3Location"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"createdAt":{"type":"integer","format":"int64"},"type":{"$ref":"#/components/schemas/agent_BackupRestoreType"},"topic":{"type":"string"},"connectCluster":{"type":"string"},"connectorName":{"type":"string"},"connectorVersion":{"type":"string"},"s3Location":{"type":"string"},"reference":{"type":"string"}}},"agent_BackupRestoreType":{"type":"string","enum":["Backup","Restore"]}}}}
```

## The agent\_BackupRestoreResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupRestoreResponse":{"required":["id","connector","cluster"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"connector":{"type":"string"},"cluster":{"type":"string"}}}}}}
```

## The agent\_BackupRestoreState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/agent_Backup"},{"$ref":"#/components/schemas/agent_BackupRestore"},{"$ref":"#/components/schemas/agent_Restore"}]},"agent_Backup":{"type":"object"},"agent_BackupRestore":{"type":"object"},"agent_Restore":{"type":"object"}}}}
```

## The agent\_BackupRestoreType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupRestoreType":{"type":"string","enum":["Backup","Restore"]}}}}
```

## The agent\_BackupTopicRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BackupTopicRequest":{"required":["cluster","s3"],"type":"object","properties":{"cluster":{"type":"string"},"s3":{"$ref":"#/components/schemas/agent_S3Bucket"},"flush":{"$ref":"#/components/schemas/agent_BackupFlushSettings"}}},"agent_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}},"agent_BackupFlushSettings":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"interval":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_BadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BadRequest":{"required":["error"],"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"error":{"type":"string"},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_BulkDeleteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkDeleteRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/agent_BulkDeleteRequestItem"}}}},"agent_BulkDeleteRequestItem":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The agent\_BulkDeleteRequestItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkDeleteRequestItem":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The agent\_BulkDeleteResult object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkDeleteResult":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/agent_BulkDeleteResultItem"}}}},"agent_BulkDeleteResultItem":{"required":["id","success"],"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"}}}}}}
```

## The agent\_BulkDeleteResultItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkDeleteResultItem":{"required":["id","success"],"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"message":{"type":"string"}}}}}}
```

## The agent\_BulkPartitionOffsetDeleteRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkPartitionOffsetDeleteRequest":{"required":["topics"],"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The agent\_BulkPartitionOffsetRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_BulkPartitionOffsetRequest":{"oneOf":[{"$ref":"#/components/schemas/agent_End1"},{"$ref":"#/components/schemas/agent_Start1"},{"$ref":"#/components/schemas/agent_Timestamp"}]},"agent_End1":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_Start1":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_Timestamp":{"required":["target"],"type":"object","properties":{"target":{"type":"string","format":"date-time"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The agent\_Capacity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}}}}}
```

## The agent\_Category object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Category":{"type":"string","enum":["Infrastructure","Consumers","Kafka Connect","Topics","Data Produced","Apps"]}}}}
```

## The agent\_ChangeDockerImageRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ChangeDockerImageRequest":{"required":["image"],"type":"object","properties":{"image":{"type":"string","minLength":1}}}}}}
```

## The agent\_ChangeDockerImageResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ChangeDockerImageResponse":{"required":["id"],"type":"object","properties":{"id":{"type":"string","minLength":1}}}}}}
```

## The agent\_ChannelField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ChannelField":{"type":"string","enum":["name","templateName","createdAt","updatedAt"]}}}}
```

## The agent\_ChannelSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}}}}}
```

## The agent\_ChannelTemplate object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ChannelTemplate":{"required":["id","name","templateVersion","version","enabled","builtIn","metadata","jsonSchema"],"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"templateVersion":{"type":"integer"},"version":{"type":"string"},"enabled":{"type":"boolean"},"builtIn":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/agent_TemplateMetadata"},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/agent_TemplateProperty"}},"suitableConnections":{"type":"array","items":{"$ref":"#/components/schemas/agent_SuitableConnection"}},"jsonSchema":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_TemplateMetadata":{"required":["author"],"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}},"agent_TemplateProperty":{"required":["id","key","displayName","type","required","provided"],"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"placeholder":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_TemplatePropertyType"},"required":{"type":"boolean"},"provided":{"type":"boolean"}}},"agent_TemplatePropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"},"enumValues":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]},"agent_SuitableConnection":{"required":["templateName","name"],"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_ClustersInfoWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ClustersInfoWithLrn":{"type":"object","properties":{"kubernetes":{"type":"array","items":{"$ref":"#/components/schemas/agent_KubernetesClusterWithLrn"}},"connect":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectClusterWithLrn"}}}},"agent_KubernetesClusterWithLrn":{"required":["cluster","version","lrn"],"type":"object","properties":{"cluster":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"lrn":{"type":"string"}}},"agent_ConnectClusterWithLrn":{"required":["cluster","version","lrn"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The agent\_ConditionDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{}}}}
```

## The agent\_ConditionalAlertRuleDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConditionalAlertRuleDetails":{"required":["conditions","alertType"],"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/agent_Map_UUID_ConditionDetails"},"alertType":{"$ref":"#/components/schemas/agent_AlertType"}}},"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]}}}}
```

## The agent\_Config object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Config":{"type":"object","properties":{"compatibility":{"type":"string"}}}}}}
```

## The agent\_Conflict object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Conflict":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_ConnectClusterWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectClusterWithLrn":{"required":["cluster","version","lrn"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The agent\_ConnectInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectInfo":{"required":["name","version"],"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}}}}
```

## The agent\_ConnectStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]}}}}
```

## The agent\_ConnectionEntities object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionEntities":{"required":["connectionName","connectionType"],"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyDatasetMatch"}}}},"agent_PolicyDatasetMatch":{"required":["datasetName"],"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ConnectionJsonResponseV2WithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionJsonResponseV2WithLrn":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configuration","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string","description":"A Lenses resource name identifier"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configuration":{"type":"object"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}}}}}
```

## The agent\_ConnectionProperty object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionProperty":{"required":["key","displayName","type","required","mounted","provided"],"type":"object","properties":{"key":{"type":"string","description":"The key of the property"},"displayName":{"type":"string"},"placeholder":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ConnectionPropertyType"},"enumValues":{"type":"array","items":{"type":"string"},"description":"For enum properties, the set of valid values","minItems":1},"required":{"type":"boolean"},"mounted":{"type":"boolean","description":"Denotes a file property which expects an [uploaded file reference](#operation/uploadFile) as its value"},"provided":{"type":"boolean"}}},"agent_ConnectionPropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]}}}}
```

## The agent\_ConnectionPropertyType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionPropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]}}}}
```

## The agent\_ConnectionStateResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionStateResponse":{"required":["name","version"],"type":"object","properties":{"name":{"type":"string"},"version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ConnectionStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionStatus":{"type":"string","enum":["Green","Yellow","Red"]}}}}
```

## The agent\_ConnectionSummaryResponseWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionSummaryResponseWithLrn":{"required":["name","lrn","templateName","templateVersion","deletable"],"type":"object","properties":{"name":{"type":"string"},"lrn":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}}}}}
```

## The agent\_ConnectionTemplateMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionTemplateMetadata":{"required":["author"],"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_ConnectionTemplateResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectionTemplateResponse":{"required":["name","templateVersion","version","enabled","builtIn","category","type","metadata","jsonSchema","creatable"],"type":"object","properties":{"name":{"type":"string","description":"The name of the template"},"templateVersion":{"type":"integer"},"version":{"type":"string"},"enabled":{"type":"boolean"},"builtIn":{"type":"boolean"},"category":{"$ref":"#/components/schemas/agent_TemplateCategory"},"type":{"$ref":"#/components/schemas/agent_TemplateType"},"kind":{"$ref":"#/components/schemas/agent_TemplateType"},"metadata":{"$ref":"#/components/schemas/agent_ConnectionTemplateMetadata"},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectionProperty"},"description":"Array of objects describing the schema of each configuration property for connections of this type"},"jsonSchema":{"$ref":"#/components/schemas/agent_JsonObject"},"creatable":{"type":"boolean"}}},"agent_TemplateCategory":{"type":"string","enum":["Connection","Application","Channel","Deployment"]},"agent_TemplateType":{"type":"string","enum":["Not Applicable","SQLRunner","Kubernetes","InProc","Connect","Alert Channel","Audit Channel","SchemaRegistry"]},"agent_ConnectionTemplateMetadata":{"required":["author"],"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}},"agent_ConnectionProperty":{"required":["key","displayName","type","required","mounted","provided"],"type":"object","properties":{"key":{"type":"string","description":"The key of the property"},"displayName":{"type":"string"},"placeholder":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ConnectionPropertyType"},"enumValues":{"type":"array","items":{"type":"string"},"description":"For enum properties, the set of valid values","minItems":1},"required":{"type":"boolean"},"mounted":{"type":"boolean","description":"Denotes a file property which expects an [uploaded file reference](#operation/uploadFile) as its value"},"provided":{"type":"boolean"}}},"agent_ConnectionPropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_ConnectorOffsetEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectorOffsetEntry":{"required":["partition"],"type":"object","properties":{"partition":{"$ref":"#/components/schemas/agent_Json"},"offset":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_ConnectorOffsetsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectorOffsetsRequest":{"type":"object","properties":{"offsets":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectorOffsetEntry"}}}},"agent_ConnectorOffsetEntry":{"required":["partition"],"type":"object","properties":{"partition":{"$ref":"#/components/schemas/agent_Json"},"offset":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_ConnectorOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectorOffsetsResponse":{"type":"object","properties":{"offsets":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectorOffsetEntry"}}}},"agent_ConnectorOffsetEntry":{"required":["partition"],"type":"object","properties":{"partition":{"$ref":"#/components/schemas/agent_Json"},"offset":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_ConnectorStateSet object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConnectorStateSet":{"type":"string","enum":["start","stop","restart","pause","resume"]}}}}
```

## The agent\_ConsumerCoordinator object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}}}}}
```

## The agent\_ConsumerGroupState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]}}}}
```

## The agent\_CreateNewEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_CreateNewEntity":{"required":["entityName","entityType","settings","metadata"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"settings":{"$ref":"#/components/schemas/agent_Settings"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"}}},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_CreateTopicDataFormatV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/agent_DecoderType"},"schema":{"type":"string"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_CreateTopicMessageFormatV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_CreateTopicMessageFormatV1":{"required":["key","value"],"type":"object","properties":{"key":{"$ref":"#/components/schemas/agent_CreateTopicDataFormatV1"},"value":{"$ref":"#/components/schemas/agent_CreateTopicDataFormatV1"}}},"agent_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/agent_DecoderType"},"schema":{"type":"string"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_CreateTopicRequestV1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_CreateTopicRequestV1":{"required":["name","configs","format"],"type":"object","properties":{"name":{"type":"string"},"replication":{"type":"integer"},"partitions":{"type":"integer"},"configs":{"$ref":"#/components/schemas/agent_Map_String_String"},"format":{"$ref":"#/components/schemas/agent_CreateTopicMessageFormatV1"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}},"agent_CreateTopicMessageFormatV1":{"required":["key","value"],"type":"object","properties":{"key":{"$ref":"#/components/schemas/agent_CreateTopicDataFormatV1"},"value":{"$ref":"#/components/schemas/agent_CreateTopicDataFormatV1"}}},"agent_CreateTopicDataFormatV1":{"required":["format"],"type":"object","properties":{"format":{"$ref":"#/components/schemas/agent_DecoderType"},"schema":{"type":"string"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_DailyMessages object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DailyMessages":{"required":["date"],"type":"object","properties":{"date":{"type":"string","format":"date-time"},"messagesCount":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_DatasetConnectionResult object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetConnectionResult":{"required":["name","sourceType","connectionStatus"],"type":"object","properties":{"name":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/agent_SourceType"},"connectionStatus":{"$ref":"#/components/schemas/agent_ConnectionStatus"}}},"agent_SourceType":{"type":"string","enum":["Kafka","SchemaRegistrySubject"]},"agent_ConnectionStatus":{"type":"string","enum":["Green","Yellow","Red"]}}}}
```

## The agent\_DatasetConnections object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetConnections":{"type":"object","properties":{"connections":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetConnectionResult"}}}},"agent_DatasetConnectionResult":{"required":["name","sourceType","connectionStatus"],"type":"object","properties":{"name":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/agent_SourceType"},"connectionStatus":{"$ref":"#/components/schemas/agent_ConnectionStatus"}}},"agent_SourceType":{"type":"string","enum":["Kafka","SchemaRegistrySubject"]},"agent_ConnectionStatus":{"type":"string","enum":["Green","Yellow","Red"]}}}}
```

## The agent\_DatasetField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetField":{"type":"string","enum":["name","records","connectionName","sourceType","isSystemEntity","recordsPerSecond","keyType","valueType","replication","consumers","partitions","retentionBytes","retentionMs","sizeBytes","version","format","compatibility","backupRestoreState"]}}}}
```

## The agent\_DatasetMatchWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetMatchWithLrn":{"oneOf":[{"$ref":"#/components/schemas/agent_Kafka"},{"$ref":"#/components/schemas/agent_SchemaRegistrySubject"}],"discriminator":{"propertyName":"sourceType","mapping":{"Kafka":"#/components/schemas/agent_Kafka","SchemaRegistrySubject":"#/components/schemas/agent_SchemaRegistrySubject"}}},"agent_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/agent_BackupRestoreState"},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/agent_Backup"},{"$ref":"#/components/schemas/agent_BackupRestore"},{"$ref":"#/components/schemas/agent_Restore"}]},"agent_Backup":{"type":"object"},"agent_BackupRestore":{"type":"object"},"agent_Restore":{"type":"object"},"agent_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaVersion"},"minItems":1},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"agent_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}}}}}}}
```

## The agent\_DatasetTag object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The agent\_DatasetTag1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DatasetTag1":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The agent\_DecoderType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_DefaultMax object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DefaultMax":{"required":["max"],"type":"object","properties":{"default":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_DefaultTopicConfigs object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DefaultTopicConfigs":{"required":["default","serverDefaultProperties","description"],"type":"object","properties":{"default":{"type":"string"},"serverDefaultProperties":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_DeleteExistingEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DeleteExistingEntity":{"required":["entityName","entityType","metadata"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"}}},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_DeploymentDescriptionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DeploymentDescriptionRequest":{"oneOf":[{"$ref":"#/components/schemas/agent_KubernetesDeployment"},{"$ref":"#/components/schemas/agent_LensesDeployment"}]},"agent_KubernetesDeployment":{"required":["details"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_KubernetesDescription"}}},"agent_KubernetesDescription":{"required":["runners","cluster","namespace"],"type":"object","properties":{"runners":{"type":"integer"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"requestedCpu":{"type":"number","format":"double"},"limitCpu":{"type":"number","format":"double"},"requestedMemory":{"type":"integer"},"limitMemory":{"type":"integer"}}},"agent_LensesDeployment":{"type":"object"}}}}
```

## The agent\_DeploymentStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DeploymentStatus":{"required":["level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/agent_ProcessorApiStatus"},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_ReplicaApiDetails"}}}},"agent_ProcessorApiStatus":{"type":"string","enum":["NOT_RUNNING","RUNNING","WARNING","FAILED","PENDING"]},"agent_ReplicaApiDetails":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"$ref":"#/components/schemas/agent_ReplicaApiStatus"},"msg":{"type":"string","minLength":1}}},"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]}}}}
```

## The agent\_End object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_End":{"type":"object"}}}}
```

## The agent\_End1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_End1":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The agent\_EntityType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_EntityType":{"type":"string","enum":["KafkaTopic"]}}}}
```

## The agent\_ExecutionStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ExecutionStatus":{"type":"string","enum":["Completed","Killed","Running"]}}}}
```

## The agent\_ExecutionView object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ExecutionView":{"required":["id","started","sql","username","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"started":{"type":"string","format":"date-time"},"finished":{"type":"string","format":"date-time"},"sql":{"type":"string"},"username":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_ExecutionStatus"},"message":{"type":"string"}}},"agent_ExecutionStatus":{"type":"string","enum":["Completed","Killed","Running"]}}}}
```

## The agent\_ExternalApplicationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ExternalApplicationRequest":{"required":["name","metadata"],"type":"object","properties":{"name":{"type":"string","description":"name should be unique, alphanumeric set of characters"},"metadata":{"$ref":"#/components/schemas/agent_AppMetadata"},"input":{"type":"array","items":{"$ref":"#/components/schemas/agent_ApplicationInputOutputEntry"}},"output":{"type":"array","items":{"$ref":"#/components/schemas/agent_ApplicationInputOutputEntry"}},"runners":{"type":"array","items":{"$ref":"#/components/schemas/agent_Runner"}}}},"agent_AppMetadata":{"type":"object","properties":{"version":{"type":"string","description":"version of the app"},"description":{"type":"string","description":"description of the app"},"owner":{"type":"string","description":"name of the owner of the app"},"appType":{"type":"string","description":"type of the app"},"tags":{"type":"array","items":{"type":"string"},"description":"a set of unique strings"},"deployment":{"type":"string","description":"deployment of the app"}}},"agent_ApplicationInputOutputEntry":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Node Name"}}},"agent_Runner":{"required":["url"],"type":"object","properties":{"url":{"type":"string","description":"Url of the HealthCheck URL Endpoint"},"name":{"type":"string","description":"Name of the Runner"},"healthCheckInterval":{"type":"integer","description":"How frequently we poll for updates(In ms)","format":"int64"}}}}}}
```

## The agent\_Field object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The agent\_FieldError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_FieldName object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The agent\_FieldTypeDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}}}}}
```

## The agent\_Fields object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The agent\_FileMetadataEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_FileMetadataEntity":{"required":["id","filename","uploadedBy","uploadedAt","size"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"uploadedBy":{"type":"string"},"uploadedAt":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"contentType":{"type":"string"}}}}}}
```

## The agent\_FixedAlertRuleDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_FixedAlertRuleDetails":{"required":["alertType","modifiedBy","modifiedAt"],"type":"object","properties":{"alertType":{"$ref":"#/components/schemas/agent_AlertType"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{}}}}
```

## The agent\_Forbidden object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Forbidden":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_Highlight object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}}}}}
```

## The agent\_Highlight1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Highlight1":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HighlightType"}}},"agent_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]}}}}
```

## The agent\_HighlightType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]}}}}
```

## The agent\_HintType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]}}}}
```

## The agent\_HttpAcl object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpAcl":{"required":["resourceType","resourceName","principal","permissionType","host","operation","lrn"],"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"},"patternType":{"type":"string"},"principal":{"type":"string"},"permissionType":{"type":"string"},"host":{"type":"string"},"operation":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The agent\_HttpAlert object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpAlert":{"required":["level","category","instance","summary","timestamp","alertId","map","lrn"],"type":"object","properties":{"level":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"instance":{"type":"string"},"summary":{"type":"string"},"docs":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"alertId":{"type":"integer"},"map":{"$ref":"#/components/schemas/agent_Map_String_String"},"lrn":{"type":"string"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_HttpAlertRule object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpAlertRule":{"required":["id","description","category","enabled","isAvailable","details","lrn"],"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"category":{"$ref":"#/components/schemas/agent_Category"},"enabled":{"type":"boolean"},"conditionTemplate":{"type":"string"},"conditionRegex":{"type":"string"},"docs":{"type":"string"},"isAvailable":{"type":"boolean"},"details":{"$ref":"#/components/schemas/agent_AlertRuleDetails"},"lrn":{"type":"string"}}},"agent_Category":{"type":"string","enum":["Infrastructure","Consumers","Kafka Connect","Topics","Data Produced","Apps"]},"agent_AlertRuleDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_ConditionalAlertRuleDetails"},{"$ref":"#/components/schemas/agent_FixedAlertRuleDetails"}]},"agent_ConditionalAlertRuleDetails":{"required":["conditions","alertType"],"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/agent_Map_UUID_ConditionDetails"},"alertType":{"$ref":"#/components/schemas/agent_AlertType"}}},"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]},"agent_FixedAlertRuleDetails":{"required":["alertType","modifiedBy","modifiedAt"],"type":"object","properties":{"alertType":{"$ref":"#/components/schemas/agent_AlertType"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}}}}}
```

## The agent\_HttpAlterOffsetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpAlterOffsetsResponse":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}}}}}}
```

## The agent\_HttpApplication object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpApplication":{"required":["id","lrn","name","type"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The agent\_HttpApplicationDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpApplicationDetails":{"required":["name","processorId","lrn","otherSettings"],"type":"object","properties":{"name":{"type":"string","minLength":1},"processorId":{"type":"string","minLength":1},"lrn":{"type":"string","minLength":1},"sql":{"type":"string","minLength":1},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"}}},"agent_TopicApiDetails":{"required":["name","keyFormat","valueFormat"],"type":"object","properties":{"name":{"type":"string","minLength":1},"keyFormat":{"$ref":"#/components/schemas/agent_DecoderType"},"valueFormat":{"$ref":"#/components/schemas/agent_DecoderType"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]},"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}}}}}
```

## The agent\_HttpBackupRestoreSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpBackupRestoreSummary":{"required":["id","createdAt"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"topic":{"type":"string"},"connectCluster":{"type":"string"},"connectorName":{"type":"string"},"connectorVersion":{"type":"string"},"s3Location":{"type":"string"},"reference":{"type":"string"}}}}}}
```

## The agent\_HttpCategorisedAlertRules object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpCategorisedAlertRules":{"required":["categories"],"type":"object","properties":{"categories":{"$ref":"#/components/schemas/agent_Map_Category_List_HttpAlertRule"}}},"agent_Map_Category_List_HttpAlertRule":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpAlertRule"}}},"agent_HttpAlertRule":{"required":["id","description","category","enabled","isAvailable","details","lrn"],"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"category":{"$ref":"#/components/schemas/agent_Category"},"enabled":{"type":"boolean"},"conditionTemplate":{"type":"string"},"conditionRegex":{"type":"string"},"docs":{"type":"string"},"isAvailable":{"type":"boolean"},"details":{"$ref":"#/components/schemas/agent_AlertRuleDetails"},"lrn":{"type":"string"}}},"agent_Category":{"type":"string","enum":["Infrastructure","Consumers","Kafka Connect","Topics","Data Produced","Apps"]},"agent_AlertRuleDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_ConditionalAlertRuleDetails"},{"$ref":"#/components/schemas/agent_FixedAlertRuleDetails"}]},"agent_ConditionalAlertRuleDetails":{"required":["conditions","alertType"],"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/agent_Map_UUID_ConditionDetails"},"alertType":{"$ref":"#/components/schemas/agent_AlertType"}}},"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]},"agent_FixedAlertRuleDetails":{"required":["alertType","modifiedBy","modifiedAt"],"type":"object","properties":{"alertType":{"$ref":"#/components/schemas/agent_AlertType"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}}}}}
```

## The agent\_HttpChannelEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpChannelEntity":{"required":["id","name","templateName","templateVersion","connectionName","createdAt","createdBy","updatedAt","updatedBy","enabled","lrn"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/agent_PropertyValue"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_HttpConnectPluginItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConnectPluginItem":{"required":["class","cluster","type","version"],"type":"object","properties":{"class":{"type":"string"},"cluster":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"}}}}}}
```

## The agent\_HttpConnectorDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConnectorDetails":{"required":["name","lrn","cluster"],"type":"object","properties":{"name":{"type":"string"},"lrn":{"type":"string"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"},"type":{"type":"string"},"className":{"type":"string"},"workerId":{"type":"string"},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"cluster":{"type":"string"},"config":{"$ref":"#/components/schemas/agent_Map_String_String"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/agent_TaskDetails"}},"code":{"type":"string"},"__errors":{"type":"array","items":{"$ref":"#/components/schemas/agent_RedactedError"}}}},"agent_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}},"agent_TaskDetails":{"required":["id","state","workerId"],"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string"},"workerId":{"type":"string"},"trace":{"type":"string"}}},"agent_RedactedError":{"required":["field","reason"],"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}}}}
```

## The agent\_HttpConnectorListItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConnectorListItem":{"required":["name","lrn","cluster"],"type":"object","properties":{"name":{"type":"string"},"lrn":{"type":"string"},"cluster":{"type":"string"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpSimpleTaskItem"}},"className":{"type":"string"},"type":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"}}},"agent_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"agent_HttpSimpleTaskItem":{"required":["id","state"],"type":"object","properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"}}}}}}
```

## The agent\_HttpConnectorValidationField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConnectorValidationField":{"required":["name","required","order","documentation","visible"],"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"order":{"type":"integer"},"documentation":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"visible":{"type":"boolean"},"value":{"type":"string"},"defaultValue":{"type":"string"}}}}}}
```

## The agent\_HttpConnectorValidationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConnectorValidationResponse":{"required":["class"],"type":"object","properties":{"class":{"type":"string"},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpConnectorValidationField"}}}},"agent_HttpConnectorValidationField":{"required":["name","required","order","documentation","visible"],"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"order":{"type":"integer"},"documentation":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"visible":{"type":"boolean"},"value":{"type":"string"},"defaultValue":{"type":"string"}}}}}}
```

## The agent\_HttpConsumersGroupInfoShort object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpConsumersGroupInfoShort":{"required":["id","lrn","active","state","consumersCount","topicPartitionsCount","coverage"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"coordinator":{"$ref":"#/components/schemas/agent_ConsumerCoordinator"},"active":{"type":"boolean"},"state":{"$ref":"#/components/schemas/agent_ConsumerGroupState"},"consumers":{"type":"array","items":{"type":"string"}},"consumersCount":{"type":"integer"},"topicPartitionsCount":{"type":"integer"},"minLag":{"type":"integer","format":"int64"},"maxLag":{"type":"integer","format":"int64"},"application":{"$ref":"#/components/schemas/agent_HttpApplication"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}},"agent_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]},"agent_HttpApplication":{"required":["id","lrn","name","type"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpDataResponse\_HttpConnectPluginItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpDataResponse_HttpConnectPluginItem":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpConnectPluginItem"}}}},"agent_HttpConnectPluginItem":{"required":["class","cluster","type","version"],"type":"object","properties":{"class":{"type":"string"},"cluster":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"docs":{"type":"string"}}}}}}
```

## The agent\_HttpDataResponse\_HttpConnectorListItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpDataResponse_HttpConnectorListItem":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpConnectorListItem"}}}},"agent_HttpConnectorListItem":{"required":["name","lrn","cluster"],"type":"object","properties":{"name":{"type":"string"},"lrn":{"type":"string"},"cluster":{"type":"string"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpSimpleTaskItem"}},"className":{"type":"string"},"type":{"type":"string"},"author":{"type":"string"},"icon":{"type":"string"}}},"agent_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]},"agent_HttpSimpleTaskItem":{"required":["id","state"],"type":"object","properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"}}}}}}
```

## The agent\_HttpDeploymentDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpDeploymentDetails":{"required":["details","status"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_HttpDeploymentSpecificDetails"},"status":{"$ref":"#/components/schemas/agent_DeploymentStatus"}}},"agent_HttpDeploymentSpecificDetails":{"required":["replicas","otherSettings","labels"],"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"labels":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1}}},"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}},"agent_DeploymentStatus":{"required":["level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/agent_ProcessorApiStatus"},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_ReplicaApiDetails"}}}},"agent_ProcessorApiStatus":{"type":"string","enum":["NOT_RUNNING","RUNNING","WARNING","FAILED","PENDING"]},"agent_ReplicaApiDetails":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"$ref":"#/components/schemas/agent_ReplicaApiStatus"},"msg":{"type":"string","minLength":1}}},"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]}}}}
```

## The agent\_HttpDeploymentSpecificDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpDeploymentSpecificDetails":{"required":["replicas","otherSettings","labels"],"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"labels":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1}}},"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}}}}}
```

## The agent\_HttpGetSqlProcessorApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpGetSqlProcessorApiResponse":{"required":["id","application","metadata","deployment","coverage"],"type":"object","properties":{"id":{"type":"string","minLength":1},"application":{"$ref":"#/components/schemas/agent_HttpApplicationDetails"},"metadata":{"$ref":"#/components/schemas/agent_MetadataDetails"},"deployment":{"$ref":"#/components/schemas/agent_HttpDeploymentDetails"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_HttpApplicationDetails":{"required":["name","processorId","lrn","otherSettings"],"type":"object","properties":{"name":{"type":"string","minLength":1},"processorId":{"type":"string","minLength":1},"lrn":{"type":"string","minLength":1},"sql":{"type":"string","minLength":1},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"}}},"agent_TopicApiDetails":{"required":["name","keyFormat","valueFormat"],"type":"object","properties":{"name":{"type":"string","minLength":1},"keyFormat":{"$ref":"#/components/schemas/agent_DecoderType"},"valueFormat":{"$ref":"#/components/schemas/agent_DecoderType"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]},"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}},"agent_MetadataDetails":{"required":["createdBy","createdAt","processorType"],"type":"object","properties":{"description":{"type":"string","minLength":1},"tags":{"type":"array","items":{"type":"string","minLength":1}},"createdBy":{"type":"string","minLength":1},"createdAt":{"type":"string","format":"date-time"},"processorType":{"$ref":"#/components/schemas/agent_SqlProcessorType"}}},"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]},"agent_HttpDeploymentDetails":{"required":["details","status"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_HttpDeploymentSpecificDetails"},"status":{"$ref":"#/components/schemas/agent_DeploymentStatus"}}},"agent_HttpDeploymentSpecificDetails":{"required":["replicas","otherSettings","labels"],"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"labels":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1}}},"agent_DeploymentStatus":{"required":["level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/agent_ProcessorApiStatus"},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_ReplicaApiDetails"}}}},"agent_ProcessorApiStatus":{"type":"string","enum":["NOT_RUNNING","RUNNING","WARNING","FAILED","PENDING"]},"agent_ReplicaApiDetails":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"$ref":"#/components/schemas/agent_ReplicaApiStatus"},"msg":{"type":"string","minLength":1}}},"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpGetSqlProcessorLegacyApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpGetSqlProcessorLegacyApiResponse":{"required":["user","name","id","lrn","processorId","clusterName","namespace","runners","state","processorType","settings","coverage"],"type":"object","properties":{"user":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string"},"processorId":{"type":"string"},"sql":{"type":"string"},"clusterName":{"type":"string"},"startTs":{"type":"integer","format":"int64"},"namespace":{"type":"string"},"pipeline":{"type":"string"},"runners":{"type":"integer"},"inputTopics":{"type":"array","items":{"type":"string"}},"outputTopics":{"type":"array","items":{"type":"string"}},"state":{"$ref":"#/components/schemas/agent_AppState"},"upTime":{"type":"integer","format":"int64"},"stopTs":{"type":"integer","format":"int64"},"lastAction":{"$ref":"#/components/schemas/agent_LastAction"},"processorType":{"$ref":"#/components/schemas/agent_SqlProcessorType"},"settings":{"$ref":"#/components/schemas/agent_Map_String_String"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_AppState":{"required":["deploymentStatus","runnerStatus"],"type":"object","properties":{"deploymentStatus":{"$ref":"#/components/schemas/agent_AppStateEnum"},"deploymentError":{"type":"string"},"runnerStatus":{"$ref":"#/components/schemas/agent_Map_String_Runner"}}},"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]},"agent_Map_String_Runner":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_Runner1"}},"agent_Runner1":{"required":["id","worker","status"],"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_AppStateEnum"},"errorMsg":{"type":"string"}}},"agent_LastAction":{"required":["action","msg"],"type":"object","properties":{"action":{"$ref":"#/components/schemas/agent_RunnerAction"},"msg":{"type":"string"}}},"agent_RunnerAction":{"type":"string","enum":["Scaled","Stopped","Started","ConfigChange","Recovered"]},"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpListSqlProcessorsApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpListSqlProcessorsApiResponse":{"type":"object","properties":{"processors":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpGetSqlProcessorApiResponse"}}}},"agent_HttpGetSqlProcessorApiResponse":{"required":["id","application","metadata","deployment","coverage"],"type":"object","properties":{"id":{"type":"string","minLength":1},"application":{"$ref":"#/components/schemas/agent_HttpApplicationDetails"},"metadata":{"$ref":"#/components/schemas/agent_MetadataDetails"},"deployment":{"$ref":"#/components/schemas/agent_HttpDeploymentDetails"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_HttpApplicationDetails":{"required":["name","processorId","lrn","otherSettings"],"type":"object","properties":{"name":{"type":"string","minLength":1},"processorId":{"type":"string","minLength":1},"lrn":{"type":"string","minLength":1},"sql":{"type":"string","minLength":1},"inputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"outputTopics":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicApiDetails"}},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"}}},"agent_TopicApiDetails":{"required":["name","keyFormat","valueFormat"],"type":"object","properties":{"name":{"type":"string","minLength":1},"keyFormat":{"$ref":"#/components/schemas/agent_DecoderType"},"valueFormat":{"$ref":"#/components/schemas/agent_DecoderType"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]},"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}},"agent_MetadataDetails":{"required":["createdBy","createdAt","processorType"],"type":"object","properties":{"description":{"type":"string","minLength":1},"tags":{"type":"array","items":{"type":"string","minLength":1}},"createdBy":{"type":"string","minLength":1},"createdAt":{"type":"string","format":"date-time"},"processorType":{"$ref":"#/components/schemas/agent_SqlProcessorType"}}},"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]},"agent_HttpDeploymentDetails":{"required":["details","status"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_HttpDeploymentSpecificDetails"},"status":{"$ref":"#/components/schemas/agent_DeploymentStatus"}}},"agent_HttpDeploymentSpecificDetails":{"required":["replicas","otherSettings","labels"],"type":"object","properties":{"replicas":{"type":"integer"},"otherSettings":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"labels":{"$ref":"#/components/schemas/agent_Map_Refined_Refined"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1}}},"agent_DeploymentStatus":{"required":["level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/agent_ProcessorApiStatus"},"startedAt":{"type":"string","format":"date-time"},"stoppedAt":{"type":"string","format":"date-time"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_ReplicaApiDetails"}}}},"agent_ProcessorApiStatus":{"type":"string","enum":["NOT_RUNNING","RUNNING","WARNING","FAILED","PENDING"]},"agent_ReplicaApiDetails":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"$ref":"#/components/schemas/agent_ReplicaApiStatus"},"msg":{"type":"string","minLength":1}}},"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpListSqlProcessorsLegacyApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpListSqlProcessorsLegacyApiResponse":{"type":"object","properties":{"targets":{"type":"array","items":{"$ref":"#/components/schemas/agent_Target"}},"streams":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpGetSqlProcessorLegacyApiResponse"}}}},"agent_Target":{"required":["cluster"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}}},"agent_HttpGetSqlProcessorLegacyApiResponse":{"required":["user","name","id","lrn","processorId","clusterName","namespace","runners","state","processorType","settings","coverage"],"type":"object","properties":{"user":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"lrn":{"type":"string"},"processorId":{"type":"string"},"sql":{"type":"string"},"clusterName":{"type":"string"},"startTs":{"type":"integer","format":"int64"},"namespace":{"type":"string"},"pipeline":{"type":"string"},"runners":{"type":"integer"},"inputTopics":{"type":"array","items":{"type":"string"}},"outputTopics":{"type":"array","items":{"type":"string"}},"state":{"$ref":"#/components/schemas/agent_AppState"},"upTime":{"type":"integer","format":"int64"},"stopTs":{"type":"integer","format":"int64"},"lastAction":{"$ref":"#/components/schemas/agent_LastAction"},"processorType":{"$ref":"#/components/schemas/agent_SqlProcessorType"},"settings":{"$ref":"#/components/schemas/agent_Map_String_String"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_AppState":{"required":["deploymentStatus","runnerStatus"],"type":"object","properties":{"deploymentStatus":{"$ref":"#/components/schemas/agent_AppStateEnum"},"deploymentError":{"type":"string"},"runnerStatus":{"$ref":"#/components/schemas/agent_Map_String_Runner"}}},"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]},"agent_Map_String_Runner":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_Runner1"}},"agent_Runner1":{"required":["id","worker","status"],"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_AppStateEnum"},"errorMsg":{"type":"string"}}},"agent_LastAction":{"required":["action","msg"],"type":"object","properties":{"action":{"$ref":"#/components/schemas/agent_RunnerAction"},"msg":{"type":"string"}}},"agent_RunnerAction":{"type":"string","enum":["Scaled","Stopped","Started","ConfigChange","Recovered"]},"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpNewConnector object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpNewConnector":{"required":["name","cluster","configuration"],"type":"object","properties":{"name":{"type":"string","minLength":1},"cluster":{"type":"string","minLength":1},"configuration":{"$ref":"#/components/schemas/agent_Map_Refined_String"}}},"agent_Map_Refined_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_HttpShortTopicSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpShortTopicSummary":{"required":["topicName","lrn","partitions","replication","isControlTopic","keyType","valueType","totalMessages","configs","consumers","messagesPerSecond","isMarkedForDeletion","isCompacted"],"type":"object","properties":{"topicName":{"type":"string"},"lrn":{"type":"string"},"partitions":{"type":"integer"},"replication":{"type":"integer"},"isControlTopic":{"type":"boolean"},"keyType":{"type":"string"},"valueType":{"type":"string"},"totalMessages":{"type":"integer","format":"int64"},"configs":{"type":"integer"},"consumers":{"type":"integer"},"messagesPerSecond":{"type":"integer","format":"int64"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"size":{"type":"integer","format":"int64"}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The agent\_HttpSimpleTaskItem object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpSimpleTaskItem":{"required":["id","state"],"type":"object","properties":{"id":{"type":"integer"},"state":{"$ref":"#/components/schemas/agent_ConnectStatus"}}},"agent_ConnectStatus":{"type":"string","enum":["RUNNING","UNASSIGNED","PAUSED","FAILED","RESTARTING","STOPPED"]}}}}
```

## The agent\_HttpTableMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpTableMetadata":{"required":["topicName","lrn","keyType","valueType","coverage"],"type":"object","properties":{"topicName":{"type":"string"},"lrn":{"type":"string"},"keyType":{"type":"string"},"valueType":{"type":"string"},"keySchema":{"type":"string"},"keySchemaVersion":{"type":"integer"},"keySchemaInlined":{"type":"string"},"valueSchema":{"type":"string"},"valueSchemaVersion":{"type":"integer"},"valueSchemaInlined":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"additionalInfo":{"$ref":"#/components/schemas/agent_Json"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_Json":{},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_HttpTopicSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpTopicSummary":{"required":["topicName","lrn","partitions","replication","isControlTopic","isCompacted","keyType","valueType","totalMessages","messagesPerSecond","isMarkedForDeletion","timestamp","coverage"],"type":"object","properties":{"topicName":{"type":"string"},"lrn":{"type":"string"},"partitions":{"type":"integer"},"replication":{"type":"integer"},"isControlTopic":{"type":"boolean"},"isCompacted":{"type":"boolean"},"keyType":{"type":"string"},"valueType":{"type":"string"},"totalMessages":{"type":"integer","format":"int64"},"config":{"type":"array","items":{"$ref":"#/components/schemas/agent_TableProperty"}},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpConsumersGroupInfoShort"}},"messagesPerPartition":{"type":"array","items":{"$ref":"#/components/schemas/agent_MessagesPerPartition"}},"messagesPerSecond":{"type":"integer","format":"int64"},"isMarkedForDeletion":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"keySchema":{"type":"string"},"keySchemaVersion":{"type":"integer"},"keySchemaInlined":{"type":"string"},"valueSchema":{"type":"string"},"valueSchemaVersion":{"type":"integer"},"valueSchemaInlined":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"backups":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpBackupRestoreSummary"}},"restores":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpBackupRestoreSummary"}},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_TableProperty":{"required":["name","isDefault"],"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"},"defaultValue":{"type":"string"},"documentation":{"type":"string"},"originalValue":{"type":"string"}}},"agent_HttpConsumersGroupInfoShort":{"required":["id","lrn","active","state","consumersCount","topicPartitionsCount","coverage"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"coordinator":{"$ref":"#/components/schemas/agent_ConsumerCoordinator"},"active":{"type":"boolean"},"state":{"$ref":"#/components/schemas/agent_ConsumerGroupState"},"consumers":{"type":"array","items":{"type":"string"}},"consumersCount":{"type":"integer"},"topicPartitionsCount":{"type":"integer"},"minLag":{"type":"integer","format":"int64"},"maxLag":{"type":"integer","format":"int64"},"application":{"$ref":"#/components/schemas/agent_HttpApplication"},"coverage":{"$ref":"#/components/schemas/agent_InformationCoverage"}}},"agent_ConsumerCoordinator":{"required":["id","host","port","rack"],"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"rack":{"type":"string"}}},"agent_ConsumerGroupState":{"type":"string","enum":["Unknown","Stable","Rebalancing","Dead","NoActiveMembers","ExistsNot"]},"agent_HttpApplication":{"required":["id","lrn","name","type"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]},"agent_InformationCoverage":{"type":"string","enum":["full","partial"]},"agent_MessagesPerPartition":{"required":["partition","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_HttpBackupRestoreSummary":{"required":["id","createdAt"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"createdAt":{"type":"string","format":"date-time"},"topic":{"type":"string"},"connectCluster":{"type":"string"},"connectorName":{"type":"string"},"connectorVersion":{"type":"string"},"s3Location":{"type":"string"},"reference":{"type":"string"}}}}}}
```

## The agent\_HttpValidateConnector object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_HttpValidateConnector":{"required":["name","cluster","configuration"],"type":"object","properties":{"name":{"type":"string"},"cluster":{"type":"string"},"configuration":{"$ref":"#/components/schemas/agent_Map_String_String"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_IdCreated object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_IdCreated":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}}}}}}
```

## The agent\_Impact object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Impact":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"}},"connectionEntities":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectionEntities"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}}}},"agent_ConnectionEntities":{"required":["connectionName","connectionType"],"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyDatasetMatch"}}}},"agent_PolicyDatasetMatch":{"required":["datasetName"],"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The agent\_ImpactType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ImpactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]}}}}
```

## The agent\_InferenceJobLimits object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_InferenceJobLimits":{"required":["maxCount","maxSizeBytes"],"type":"object","properties":{"maxCount":{"type":"integer"},"maxSizeBytes":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_InferenceJobRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_InferenceJobRequest":{"required":["fromTimestamp"],"type":"object","properties":{"fromTimestamp":{"type":"integer","format":"int64"},"maxCount":{"type":"integer"},"maxSizeBytes":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_InferenceJobState object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_InferenceJobState":{"required":["jobId","topicName","status","messagesProcessed","bytesProcessed","startedAtMs"],"type":"object","properties":{"jobId":{"type":"string","format":"uuid"},"topicName":{"type":"string"},"status":{"type":"string","enum":["RUNNING","COMPLETED","CANCELLED","FAILED"]},"error":{"type":"string"},"messagesProcessed":{"type":"integer","format":"int64"},"bytesProcessed":{"type":"integer","format":"int64"},"startedAtMs":{"type":"integer","format":"int64"},"finishedAtMs":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_InformationCoverage object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_InformationCoverage":{"type":"string","enum":["full","partial"]}}}}
```

## The agent\_IntellisenseResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_IntellisenseResponse":{"required":["input","caret"],"type":"object","properties":{"input":{"type":"string"},"caret":{"type":"integer"},"lints":{"type":"array","items":{"$ref":"#/components/schemas/agent_Lint"}},"suggestions":{"type":"array","items":{"$ref":"#/components/schemas/agent_Suggestion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight1"}},"statementsPositions":{"type":"array","items":{"$ref":"#/components/schemas/agent_StatementPos"}}}},"agent_Lint":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HintType"}}},"agent_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]},"agent_Suggestion":{"required":["display","text","start","end","type","highlightStart","highlightEnd"],"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}},"agent_Highlight1":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HighlightType"}}},"agent_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]},"agent_StatementPos":{"required":["index","start","end"],"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The agent\_InternalError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_InternalError":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_Json object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Json":{}}}}
```

## The agent\_JsonObject object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_Kafka object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/agent_BackupRestoreState"},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/agent_Backup"},{"$ref":"#/components/schemas/agent_BackupRestore"},{"$ref":"#/components/schemas/agent_Restore"}]},"agent_Backup":{"type":"object"},"agent_BackupRestore":{"type":"object"},"agent_Restore":{"type":"object"}}}}
```

## The agent\_KafkaConnectConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfiguration"}}},"agent_KafkaConnectConnectionConfiguration":{"required":["workers"],"type":"object","properties":{"workers":{"type":"array","items":{"type":"string"},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"sslAlgorithm":{"type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfigurationV2"}}},"agent_KafkaConnectConnectionConfigurationV2":{"required":["workers"],"type":"object","properties":{"workers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"sslAlgorithm":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionConfiguration":{"required":["workers"],"type":"object","properties":{"workers":{"type":"array","items":{"type":"string"},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"sslAlgorithm":{"type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionConfigurationV2":{"required":["workers"],"type":"object","properties":{"workers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"sslAlgorithm":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_KafkaConnectConnectionConfiguration":{"required":["workers"],"type":"object","properties":{"workers":{"type":"array","items":{"type":"string"},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"sslAlgorithm":{"type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KafkaConnectConnectionConfiguration":{"required":["workers"],"type":"object","properties":{"workers":{"type":"array","items":{"type":"string"},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"sslAlgorithm":{"type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KafkaConnectConnectionConfigurationV2":{"required":["workers"],"type":"object","properties":{"workers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"sslAlgorithm":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfiguration"}}},"agent_KafkaConnectConnectionConfiguration":{"required":["workers"],"type":"object","properties":{"workers":{"type":"array","items":{"type":"string"},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"sslAlgorithm":{"type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectConnectionConfigurationV2"}}},"agent_KafkaConnectConnectionConfigurationV2":{"required":["workers"],"type":"object","properties":{"workers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of Kafka Connect worker URLs"},"aes256Key":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"sslAlgorithm":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Name of the ssl algorithm. If empty default one will be used (X509)"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_KafkaConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectionConfiguration"}}},"agent_KafkaConnectionConfiguration":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"type":"string","description":"Kafka security protocol","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"saslMechanism":{"type":"string","description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"type":"string","description":"JAAS Login module configuration for SASL","format":"password"},"keytab":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos keytab file"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"type":"integer","description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectionConfigurationV2"}}},"agent_KafkaConnectionConfigurationV2":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}},"description":"Kafka security protocol"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"saslMechanism":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"JAAS Login module configuration for SASL"},"keytab":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos keytab file"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionConfiguration":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"type":"string","description":"Kafka security protocol","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"saslMechanism":{"type":"string","description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"type":"string","description":"JAAS Login module configuration for SASL","format":"password"},"keytab":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos keytab file"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"type":"integer","description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionConfigurationV2":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}},"description":"Kafka security protocol"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"saslMechanism":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"JAAS Login module configuration for SASL"},"keytab":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos keytab file"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_KafkaConnectionConfiguration":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"type":"string","description":"Kafka security protocol","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"saslMechanism":{"type":"string","description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"type":"string","description":"JAAS Login module configuration for SASL","format":"password"},"keytab":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos keytab file"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"type":"integer","description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KafkaConnectionConfiguration":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"type":"string","description":"Kafka security protocol","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"saslMechanism":{"type":"string","description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"type":"string","description":"JAAS Login module configuration for SASL","format":"password"},"keytab":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos keytab file"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"type":"integer","description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KafkaConnectionConfigurationV2":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}},"description":"Kafka security protocol"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"saslMechanism":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"JAAS Login module configuration for SASL"},"keytab":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos keytab file"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KafkaConnectionConfiguration"}}},"agent_KafkaConnectionConfiguration":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"type":"string","description":"Kafka security protocol","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"saslMechanism":{"type":"string","description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"type":"string","description":"JAAS Login module configuration for SASL","format":"password"},"keytab":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos keytab file"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"type":"integer","description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectionConfigurationV2"}}},"agent_KafkaConnectionConfigurationV2":{"required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."},"protocol":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}},"description":"Kafka security protocol"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"saslMechanism":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Mechanism to use when authenticated using SASL"},"saslJaasConfig":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"JAAS Login module configuration for SASL"},"keytab":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos keytab file"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP","AWS"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia or AWS metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia or AWS metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics"},"kafkaConnectivityTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Timeout (ms) for the Test Connection connectivity check"}}}}}}
```

## The agent\_KafkaTopicConfigWithDefault object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaTopicConfigWithDefault":{"required":["name","value","isDefault","isSensitive","isReadOnly"],"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"},"isSensitive":{"type":"boolean"},"isReadOnly":{"type":"boolean"}}}}}}
```

## The agent\_KerberosConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KerberosConnectionConfiguration"}}},"agent_KerberosConnectionConfiguration":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KerberosConnectionConfigurationV2"}}},"agent_KerberosConnectionConfigurationV2":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionConfiguration":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionConfigurationV2":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_KerberosConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_KerberosConnectionConfiguration":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_KerberosConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KerberosConnectionConfiguration":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_KerberosConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_KerberosConnectionConfigurationV2":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_KerberosConnectionConfiguration"}}},"agent_KerberosConnectionConfiguration":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KerberosConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_KerberosConnectionConfigurationV2"}}},"agent_KerberosConnectionConfigurationV2":{"required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"Kerberos krb5.conf file"}}}}}}
```

## The agent\_KeyDataType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]}}}}
```

## The agent\_KubernetesClusterWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KubernetesClusterWithLrn":{"required":["cluster","version","lrn"],"type":"object","properties":{"cluster":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"lrn":{"type":"string"}}}}}}
```

## The agent\_KubernetesDeployment object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KubernetesDeployment":{"required":["details"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_KubernetesDescription"}}},"agent_KubernetesDescription":{"required":["runners","cluster","namespace"],"type":"object","properties":{"runners":{"type":"integer"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"requestedCpu":{"type":"number","format":"double"},"limitCpu":{"type":"number","format":"double"},"requestedMemory":{"type":"integer"},"limitMemory":{"type":"integer"}}}}}}
```

## The agent\_KubernetesDescription object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KubernetesDescription":{"required":["runners","cluster","namespace"],"type":"object","properties":{"runners":{"type":"integer"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"requestedCpu":{"type":"number","format":"double"},"limitCpu":{"type":"number","format":"double"},"requestedMemory":{"type":"integer"},"limitMemory":{"type":"integer"}}}}}}
```

## The agent\_LastAction object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LastAction":{"required":["action","msg"],"type":"object","properties":{"action":{"$ref":"#/components/schemas/agent_RunnerAction"},"msg":{"type":"string"}}},"agent_RunnerAction":{"type":"string","enum":["Scaled","Stopped","Started","ConfigChange","Recovered"]}}}}
```

## The agent\_Lenses object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}}}}}
```

## The agent\_LensesDeployment object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LensesDeployment":{"type":"object"}}}}
```

## The agent\_LicenseError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LicenseError":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_Lint object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Lint":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HintType"}}},"agent_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]}}}}
```

## The agent\_LogLevel object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LogLevel":{"type":"string","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"]}}}}
```

## The agent\_LogPreset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LogPreset":{"required":["name","description","rootLevel"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"rootLevel":{"type":"string"}}}}}}
```

## The agent\_LoggerInfo object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LoggerInfo":{"required":["name","effectiveLevel"],"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string"},"effectiveLevel":{"type":"string"}}}}}}
```

## The agent\_LoggersResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LoggersResponse":{"required":["mode"],"type":"object","properties":{"loggers":{"type":"array","items":{"$ref":"#/components/schemas/agent_LoggerInfo"}},"mode":{"type":"string"},"activePreset":{"type":"string"}}},"agent_LoggerInfo":{"required":["name","effectiveLevel"],"type":"object","properties":{"name":{"type":"string"},"level":{"type":"string"},"effectiveLevel":{"type":"string"}}}}}}
```

## The agent\_LoggingStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LoggingStatus":{"required":["mode","configFile","autoReloadEnabled"],"type":"object","properties":{"mode":{"type":"string"},"activePreset":{"type":"string"},"configFile":{"type":"string"},"autoReloadEnabled":{"type":"boolean"},"lastModified":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Map\_Category\_List\_HttpAlertRule object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_Category_List_HttpAlertRule":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpAlertRule"}}},"agent_HttpAlertRule":{"required":["id","description","category","enabled","isAvailable","details","lrn"],"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"category":{"$ref":"#/components/schemas/agent_Category"},"enabled":{"type":"boolean"},"conditionTemplate":{"type":"string"},"conditionRegex":{"type":"string"},"docs":{"type":"string"},"isAvailable":{"type":"boolean"},"details":{"$ref":"#/components/schemas/agent_AlertRuleDetails"},"lrn":{"type":"string"}}},"agent_Category":{"type":"string","enum":["Infrastructure","Consumers","Kafka Connect","Topics","Data Produced","Apps"]},"agent_AlertRuleDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_ConditionalAlertRuleDetails"},{"$ref":"#/components/schemas/agent_FixedAlertRuleDetails"}]},"agent_ConditionalAlertRuleDetails":{"required":["conditions","alertType"],"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/agent_Map_UUID_ConditionDetails"},"alertType":{"$ref":"#/components/schemas/agent_AlertType"}}},"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{},"agent_AlertType":{"type":"string","enum":["Fixed","Conditional"]},"agent_FixedAlertRuleDetails":{"required":["alertType","modifiedBy","modifiedAt"],"type":"object","properties":{"alertType":{"$ref":"#/components/schemas/agent_AlertType"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"}}}}}}
```

## The agent\_Map\_Refined\_Refined object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_Refined_Refined":{"type":"object","additionalProperties":{"type":"string","minLength":1}}}}}
```

## The agent\_Map\_Refined\_String object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_Refined_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_Map\_String\_DefaultTopicConfigs object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_String_DefaultTopicConfigs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_DefaultTopicConfigs"}},"agent_DefaultTopicConfigs":{"required":["default","serverDefaultProperties","description"],"type":"object","properties":{"default":{"type":"string"},"serverDefaultProperties":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_Map\_String\_List\_ConnectionStateResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_String_List_ConnectionStateResponse":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectionStateResponse"}}},"agent_ConnectionStateResponse":{"required":["name","version"],"type":"object","properties":{"name":{"type":"string"},"version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_Map\_String\_Runner object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_String_Runner":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_Runner1"}},"agent_Runner1":{"required":["id","worker","status"],"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_AppStateEnum"},"errorMsg":{"type":"string"}}},"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]}}}}
```

## The agent\_Map\_String\_String object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_Map\_UUID\_ConditionDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Map_UUID_ConditionDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_ConditionDetails"}},"agent_ConditionDetails":{"required":["createdAt","createdBy","modifiedAt","modifiedBy","condition","conditionDsl"],"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"channels":{"type":"array","items":{"$ref":"#/components/schemas/agent_ChannelSummary"}},"condition":{"type":"string"},"conditionDsl":{"$ref":"#/components/schemas/agent_Json"},"conditionState":{"$ref":"#/components/schemas/agent_Json"}}},"agent_ChannelSummary":{"required":["id","name","templateName"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"}}},"agent_Json":{}}}}
```

## The agent\_MessagesPerPartition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_MessagesPerPartition":{"required":["partition","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Metadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_Metadata1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Metadata1":{"required":["version","instance"],"type":"object","properties":{"version":{"type":"string"},"instance":{"type":"string"}}}}}}
```

## The agent\_MetadataDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_MetadataDetails":{"required":["createdBy","createdAt","processorType"],"type":"object","properties":{"description":{"type":"string","minLength":1},"tags":{"type":"array","items":{"type":"string","minLength":1}},"createdBy":{"type":"string","minLength":1},"createdAt":{"type":"string","format":"date-time"},"processorType":{"$ref":"#/components/schemas/agent_SqlProcessorType"}}},"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]}}}}
```

## The agent\_MinMaybeMax object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_MinMaybeMax":{"required":["min"],"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}}}}}
```

## The agent\_MultiPartBody object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_MultiPartBody":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}}
```

## The agent\_NamingStrategy object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NamingStrategy":{"required":["pattern","description"],"type":"object","properties":{"pattern":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_Native object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}}}}}
```

## The agent\_NewChannelApiEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NewChannelApiEntity":{"required":["name","templateName","connectionName"],"type":"object","properties":{"name":{"type":"string"},"templateName":{"type":"string"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/agent_PropertyValue"}},"propertiesObject":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_NewChannelResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NewChannelResponse":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}}}}
```

## The agent\_NewPolicyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NewPolicyRequest":{"required":["name","category","impactType","obfuscation"],"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"},"impactType":{"$ref":"#/components/schemas/agent_ImpactType"},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_ImpactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]}}}}
```

## The agent\_NewRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NewRequest":{"oneOf":[{"$ref":"#/components/schemas/agent_CreateNewEntity"},{"$ref":"#/components/schemas/agent_DeleteExistingEntity"},{"$ref":"#/components/schemas/agent_UpdateExistingEntity"}]},"agent_CreateNewEntity":{"required":["entityName","entityType","settings","metadata"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"settings":{"$ref":"#/components/schemas/agent_Settings"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"}}},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"agent_DeleteExistingEntity":{"required":["entityName","entityType","metadata"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"}}},"agent_UpdateExistingEntity":{"required":["entityName","entityType","metadata","settings"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"},"settings":{"$ref":"#/components/schemas/agent_Settings"}}}}}}
```

## The agent\_NewTopicCommand object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NewTopicCommand":{"required":["topicName","configs"],"type":"object","properties":{"topicName":{"type":"string"},"replication":{"type":"integer"},"partitions":{"type":"integer"},"configs":{"$ref":"#/components/schemas/agent_Map_String_String"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_NodeType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NodeType":{"type":"string","enum":["PreDaDProcessor","Stream","Table","Topic","Sink"]}}}}
```

## The agent\_NotFound object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_NotFound":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_Order object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Order":{"type":"string","enum":["asc","desc"]}}}}
```

## The agent\_OutputPartitionOffset object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_OutputPartitionOffset":{"required":["partition","offset"],"type":"object","properties":{"partition":{"type":"integer"},"offset":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Page\_Audit object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Page_Audit":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_Audit"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_Audit":{"required":["type","action","user","timestamp","content"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/agent_AuditResource"},"action":{"$ref":"#/components/schemas/agent_AuditChange"},"user":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"content":{"$ref":"#/components/schemas/agent_Map_String_String"}}},"agent_AuditResource":{"type":"string","enum":["TOPIC","TOPIC_REQUEST","TOPIC_DATA","DATASET","QUOTAS","BROKER_CONFIG","ACL","SCHEMA","PROCESSOR","CONNECTOR","KUBERNETES_EXTERNAL_APP","KUBERNETES_SECRET","KUBERNETES_NAMESPACE","KUBERNETES_SERVICE_ACCOUNT","KUBERNETES_SERVICE","KUBERNETES_INGRESS","CONSUMER_OFFSET","CONSUMER_GROUP","DATA_POLICIES","USER_MANAGEMENT_GROUP","USER_MANAGEMENT_USER","USER_MANAGEMENT_SERVICE_ACCOUNT","LENSES","USER","CREDENTIALS","CONNECTION","ALERT_EVENT","ALERT_RULE","ALERT_CHANNEL","AUDIT_CHANNEL","EXTERNAL_APP","UNKNOWN","TOPIC_SETTINGS"]},"agent_AuditChange":{"type":"string","enum":["ADD","REMOVE","UPDATE","PATCH","INSERT","STARTED","STOPPED","SCALED","RESTARTED","PAUSED","VIEWED","LOGIN","LOGOUT","REQUESTED","REJECTED","APPROVED","FAILED","UNKNOWN"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_Page\_DatasetMatchWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Page_DatasetMatchWithLrn":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetMatchWithLrn"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_DatasetMatchWithLrn":{"oneOf":[{"$ref":"#/components/schemas/agent_Kafka"},{"$ref":"#/components/schemas/agent_SchemaRegistrySubject"}],"discriminator":{"propertyName":"sourceType","mapping":{"Kafka":"#/components/schemas/agent_Kafka","SchemaRegistrySubject":"#/components/schemas/agent_SchemaRegistrySubject"}}},"agent_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/agent_BackupRestoreState"},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/agent_Backup"},{"$ref":"#/components/schemas/agent_BackupRestore"},{"$ref":"#/components/schemas/agent_Restore"}]},"agent_Backup":{"type":"object"},"agent_BackupRestore":{"type":"object"},"agent_Restore":{"type":"object"},"agent_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaVersion"},"minItems":1},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"agent_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}}}}}}}
```

## The agent\_Page\_HttpAlert object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Page_HttpAlert":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpAlert"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_HttpAlert":{"required":["level","category","instance","summary","timestamp","alertId","map","lrn"],"type":"object","properties":{"level":{"type":"string"},"category":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"instance":{"type":"string"},"summary":{"type":"string"},"docs":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"alertId":{"type":"integer"},"map":{"$ref":"#/components/schemas/agent_Map_String_String"},"lrn":{"type":"string"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_Page\_HttpChannelEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Page_HttpChannelEntity":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpChannelEntity"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_HttpChannelEntity":{"required":["id","name","templateName","templateVersion","connectionName","createdAt","createdBy","updatedAt","updatedBy","enabled","lrn"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"templateName":{"type":"string"},"templateVersion":{"type":"integer"},"connectionName":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/agent_PropertyValue"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"enabled":{"type":"boolean"},"lrn":{"type":"string"}}},"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_Page\_Request object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Page_Request":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_Request"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_Request":{"required":["id","entityName","type","entityType","settings","metadata","createdAt","createdBy","approvalStatus","defaultTopicConfig"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"entityName":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_RequestType"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"settings":{"$ref":"#/components/schemas/agent_Settings"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"approvalStatus":{"$ref":"#/components/schemas/agent_ApprovalStatus"},"rejectionReason":{"type":"string"},"failureReason":{"type":"string"},"reviewedBy":{"type":"string"},"reviewedAt":{"type":"string","format":"date-time"},"defaultTopicConfig":{"$ref":"#/components/schemas/agent_Map_String_DefaultTopicConfigs"}}},"agent_RequestType":{"type":"string","enum":["Create","Update","Delete"]},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"agent_ApprovalStatus":{"type":"string","enum":["Approved","Pending","Rejected","Failed"]},"agent_Map_String_DefaultTopicConfigs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_DefaultTopicConfigs"}},"agent_DefaultTopicConfigs":{"required":["default","serverDefaultProperties","description"],"type":"object","properties":{"default":{"type":"string"},"serverDefaultProperties":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_Paging object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Paging":{"required":["tableName","type","label"],"type":"object","properties":{"tableName":{"$ref":"#/components/schemas/agent_TableName"},"type":{"$ref":"#/components/schemas/agent_PagingType"},"label":{"type":"string"},"partitions":{"type":"array","items":{"$ref":"#/components/schemas/agent_PagingPartition"}}}},"agent_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"agent_PagingType":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"agent_PagingPartition":{"required":["id","label","start","end"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/agent_Partition1"},"label":{"type":"string"},"start":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}},"agent_Partition1":{"required":["value"],"type":"object","properties":{"value":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_PagingPartition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PagingPartition":{"required":["id","label","start","end"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/agent_Partition1"},"label":{"type":"string"},"start":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}},"agent_Partition1":{"required":["value"],"type":"object","properties":{"value":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_PagingType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PagingType":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The agent\_Partition object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Partition":{"required":["partition","leader","preferredLeader"],"type":"object","properties":{"partition":{"type":"integer"},"leader":{"type":"integer"},"preferredLeader":{"type":"integer"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_PartitionReplica"}}}},"agent_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The agent\_Partition1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Partition1":{"required":["value"],"type":"object","properties":{"value":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_PartitionDTO object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PartitionDTO":{"type":"object","properties":{"partitions":{"type":"array","items":{"$ref":"#/components/schemas/agent_PartitionV2"}},"jmxLastRetrievedAt":{"type":"string","format":"date-time"}}},"agent_PartitionV2":{"required":["partition","leader","preferredLeader","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"leader":{"type":"integer"},"preferredLeader":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"},"bytes":{"type":"integer","format":"int64"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_PartitionReplica"}}}},"agent_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The agent\_PartitionIncrease object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PartitionIncrease":{"required":["partitions"],"type":"object","properties":{"partitions":{"type":"integer"}}}}}}
```

## The agent\_PartitionReplica object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The agent\_PartitionV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PartitionV2":{"required":["partition","leader","preferredLeader","messages","begin","end"],"type":"object","properties":{"partition":{"type":"integer"},"leader":{"type":"integer"},"preferredLeader":{"type":"integer"},"messages":{"type":"integer","format":"int64"},"begin":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"},"bytes":{"type":"integer","format":"int64"},"replicas":{"type":"array","items":{"$ref":"#/components/schemas/agent_PartitionReplica"}}}},"agent_PartitionReplica":{"required":["broker","leader","inSync"],"type":"object","properties":{"broker":{"type":"integer"},"leader":{"type":"boolean"},"inSync":{"type":"boolean"}}}}}}
```

## The agent\_PatchChannelApiEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PatchChannelApiEntity":{"type":"object","properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/agent_PropertyValue"}},"propertiesObject":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_PolicyDatasetMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PolicyDatasetMatch":{"required":["datasetName"],"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_PolicyFieldMatch object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_PolicyMatchDetailsWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_PolicyWithLrn object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PolicyWithLrn":{"required":["id","lrn","name","category","impactType","obfuscation","versions","lastUpdated","lastUpdatedUser","impact"],"type":"object","properties":{"id":{"type":"string"},"lrn":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"impactType":{"$ref":"#/components/schemas/agent_ImpactType"},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"},"minItems":1},"versions":{"type":"integer"},"lastUpdated":{"type":"string"},"lastUpdatedUser":{"type":"string"},"impact":{"$ref":"#/components/schemas/agent_Impact"}}},"agent_ImpactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"agent_Impact":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"}},"connectionEntities":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectionEntities"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}},"processors":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/agent_Application"}}}},"agent_ConnectionEntities":{"required":["connectionName","connectionType"],"type":"object","properties":{"connectionName":{"type":"string"},"connectionType":{"type":"string"},"entities":{"type":"array","items":{"type":"string"}},"datasetsWithFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyDatasetMatch"}}}},"agent_PolicyDatasetMatch":{"required":["datasetName"],"type":"object","properties":{"datasetName":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_Application":{"required":["id","name","type"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_ApplicationType"},"cluster":{"type":"string"},"namespace":{"type":"string"}}},"agent_ApplicationType":{"type":"string","enum":["AkkaStreams","LsqlProcessor","KafkaStreams","SparkStreaming","ConnectSource","ConnectSink","Other"]}}}}
```

## The agent\_Presentation object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Presentation":{"required":["input","caret"],"type":"object","properties":{"input":{"type":"string"},"caret":{"type":"integer"},"lints":{"type":"array","items":{"$ref":"#/components/schemas/agent_Lint"}},"suggestions":{"type":"array","items":{"$ref":"#/components/schemas/agent_Suggestion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight1"}},"tables":{"type":"array","items":{"$ref":"#/components/schemas/agent_TableFields"}},"statementsPositions":{"type":"array","items":{"$ref":"#/components/schemas/agent_StatementPos"}}}},"agent_Lint":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HintType"}}},"agent_HintType":{"type":"string","enum":["Warning","Error","Obfuscation","Info","Security"]},"agent_Suggestion":{"required":["display","text","start","end","type","highlightStart","highlightEnd"],"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}},"agent_Highlight1":{"required":["start","end","text","type"],"type":"object","properties":{"start":{"type":"integer"},"end":{"type":"integer"},"text":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_HighlightType"}}},"agent_HighlightType":{"type":"string","enum":["Keyword","String","Integral","Float","Boolean","Type"]},"agent_TableFields":{"required":["tableName"],"type":"object","properties":{"tableName":{"$ref":"#/components/schemas/agent_TableName"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldName"}}}},"agent_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"agent_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"agent_StatementPos":{"required":["index","start","end"],"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The agent\_PresentationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PresentationRequest":{"required":["sql"],"type":"object","properties":{"sql":{"type":"string"},"caret":{"type":"integer"},"connectorId":{"type":"string"}}}}}}
```

## The agent\_PresentationRequest1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PresentationRequest1":{"required":["sql"],"type":"object","properties":{"sql":{"type":"string"},"caret":{"type":"integer"}}}}}}
```

## The agent\_PresetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PresetsResponse":{"type":"object","properties":{"presets":{"type":"array","items":{"$ref":"#/components/schemas/agent_LogPreset"}},"activePreset":{"type":"string"}}},"agent_LogPreset":{"required":["name","description","rootLevel"],"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"rootLevel":{"type":"string"}}}}}}
```

## The agent\_ProcessorApiStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProcessorApiStatus":{"type":"string","enum":["NOT_RUNNING","RUNNING","WARNING","FAILED","PENDING"]}}}}
```

## The agent\_ProcessorGraphNode object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProcessorGraphNode":{"required":["key","type","nodeType"],"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_TopologyNodeType"},"nodeType":{"$ref":"#/components/schemas/agent_NodeType"},"keyType":{"$ref":"#/components/schemas/agent_DecoderType"},"valueType":{"$ref":"#/components/schemas/agent_DecoderType"},"children":{"type":"array","items":{"type":"string"}}}},"agent_TopologyNodeType":{"type":"string","enum":["STREAM","TOPIC","TABLE","SELECT","FILTER","JOIN","GROUPBY","AGGREGATE","COUNT","REPARTITION","MAP","FLATMAP","SINK","SOURCE","PROCESSOR"]},"agent_NodeType":{"type":"string","enum":["PreDaDProcessor","Stream","Table","Topic","Sink"]},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_ProcessorGraphResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProcessorGraphResponse":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"string"}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/agent_ProcessorGraphNode"}}}},"agent_ProcessorGraphNode":{"required":["key","type","nodeType"],"type":"object","properties":{"key":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_TopologyNodeType"},"nodeType":{"$ref":"#/components/schemas/agent_NodeType"},"keyType":{"$ref":"#/components/schemas/agent_DecoderType"},"valueType":{"$ref":"#/components/schemas/agent_DecoderType"},"children":{"type":"array","items":{"type":"string"}}}},"agent_TopologyNodeType":{"type":"string","enum":["STREAM","TOPIC","TABLE","SELECT","FILTER","JOIN","GROUPBY","AGGREGATE","COUNT","REPARTITION","MAP","FLATMAP","SINK","SOURCE","PROCESSOR"]},"agent_NodeType":{"type":"string","enum":["PreDaDProcessor","Stream","Table","Topic","Sink"]},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_PropertyValue object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_ProvisioningValidationConnection object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProvisioningValidationConnection":{"required":["name","valid","error"],"type":"object","properties":{"name":{"type":"string"},"valid":{"type":"boolean"},"error":{"type":"string"},"lineNumbers":{"type":"array","items":{"type":"integer"}},"fieldPaths":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ProvisioningValidationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProvisioningValidationResponse":{"required":["valid","message"],"type":"object","properties":{"valid":{"type":"boolean"},"message":{"type":"string"},"connections":{"type":"array","items":{"$ref":"#/components/schemas/agent_ProvisioningValidationConnection"}},"summary":{"$ref":"#/components/schemas/agent_ProvisioningValidationSummary"}}},"agent_ProvisioningValidationConnection":{"required":["name","valid","error"],"type":"object","properties":{"name":{"type":"string"},"valid":{"type":"boolean"},"error":{"type":"string"},"lineNumbers":{"type":"array","items":{"type":"integer"}},"fieldPaths":{"type":"array","items":{"type":"string"}}}},"agent_ProvisioningValidationSummary":{"type":"object","properties":{"created":{"type":"array","items":{"type":"string"}},"updated":{"type":"array","items":{"type":"string"}},"deleted":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ProvisioningValidationSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProvisioningValidationSummary":{"type":"object","properties":{"created":{"type":"array","items":{"type":"string"}},"updated":{"type":"array","items":{"type":"string"}},"deleted":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_QuotaResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_QuotaResponse":{"required":["entityType","entityName","properties","url","lrn","isAuthorized"],"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/agent_QuotaType"},"entityName":{"type":"string"},"child":{"type":"string"},"properties":{"$ref":"#/components/schemas/agent_Map_String_String"},"url":{"type":"string"},"lrn":{"type":"string"},"isAuthorized":{"type":"boolean"}}},"agent_QuotaType":{"type":"string","enum":["USERCLIENT","CLIENTS","CLIENT","USERS","USER"]},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_QuotaType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_QuotaType":{"type":"string","enum":["USERCLIENT","CLIENTS","CLIENT","USERS","USER"]}}}}
```

## The agent\_RedactedError object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RedactedError":{"required":["field","reason"],"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}}}}
```

## The agent\_RegisterProcessorApiRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RegisterProcessorApiRequest":{"required":["name","sql","deployment"],"type":"object","properties":{"name":{"type":"string","minLength":1},"processorId":{"type":"string","minLength":1},"sql":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"deployment":{"$ref":"#/components/schemas/agent_DeploymentDescriptionRequest"},"tags":{"type":"array","items":{"type":"string","minLength":1}}}},"agent_DeploymentDescriptionRequest":{"oneOf":[{"$ref":"#/components/schemas/agent_KubernetesDeployment"},{"$ref":"#/components/schemas/agent_LensesDeployment"}]},"agent_KubernetesDeployment":{"required":["details"],"type":"object","properties":{"details":{"$ref":"#/components/schemas/agent_KubernetesDescription"}}},"agent_KubernetesDescription":{"required":["runners","cluster","namespace"],"type":"object","properties":{"runners":{"type":"integer"},"cluster":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"requestedCpu":{"type":"number","format":"double"},"limitCpu":{"type":"number","format":"double"},"requestedMemory":{"type":"integer"},"limitMemory":{"type":"integer"}}},"agent_LensesDeployment":{"type":"object"}}}}
```

## The agent\_RegisterProcessorApiResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RegisterProcessorApiResponse":{"required":["id"],"type":"object","properties":{"id":{"type":"string","minLength":1}}}}}}
```

## The agent\_RegisterProcessorLegacyApiRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RegisterProcessorLegacyApiRequest":{"required":["name","sql","runnerCount"],"type":"object","properties":{"name":{"type":"string"},"appId":{"type":"string"},"sql":{"type":"string"},"runnerCount":{"type":"integer"},"cluster":{"type":"string"},"namespace":{"type":"string"},"settings":{"$ref":"#/components/schemas/agent_Map_String_String"},"user":{"type":"string"},"pipeline":{"type":"string"}}},"agent_Map_String_String":{"type":"object","additionalProperties":{"type":"string"}}}}}
```

## The agent\_RegisterSchemaRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RegisterSchemaRequest":{"required":["schema"],"type":"object","properties":{"schema":{"type":"string"},"format":{"type":"string"}}}}}}
```

## The agent\_RegisterSchemaResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RegisterSchemaResponse":{"required":["version","schemaId"],"type":"object","properties":{"version":{"type":"integer"},"schemaId":{"type":"string"}}}}}}
```

## The agent\_RejectionMessage object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RejectionMessage":{"type":"object","properties":{"rejectionReason":{"type":"string"}}}}}}
```

## The agent\_RemoveRunnersRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RemoveRunnersRequest":{"required":["runners"],"type":"object","properties":{"runners":{"type":"array","items":{"type":"string"},"description":"A list of runners urls","minItems":1}}}}}}
```

## The agent\_ReplicaApiDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ReplicaApiDetails":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"$ref":"#/components/schemas/agent_ReplicaApiStatus"},"msg":{"type":"string","minLength":1}}},"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]}}}}
```

## The agent\_ReplicaApiStatus object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ReplicaApiStatus":{"type":"string","enum":["STOPPED","RUNNING","WARNING","FAILED","PENDING"]}}}}
```

## The agent\_Request object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Request":{"required":["id","entityName","type","entityType","settings","metadata","createdAt","createdBy","approvalStatus","defaultTopicConfig"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"entityName":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_RequestType"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"settings":{"$ref":"#/components/schemas/agent_Settings"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"approvalStatus":{"$ref":"#/components/schemas/agent_ApprovalStatus"},"rejectionReason":{"type":"string"},"failureReason":{"type":"string"},"reviewedBy":{"type":"string"},"reviewedAt":{"type":"string","format":"date-time"},"defaultTopicConfig":{"$ref":"#/components/schemas/agent_Map_String_DefaultTopicConfigs"}}},"agent_RequestType":{"type":"string","enum":["Create","Update","Delete"]},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"agent_ApprovalStatus":{"type":"string","enum":["Approved","Pending","Rejected","Failed"]},"agent_Map_String_DefaultTopicConfigs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/agent_DefaultTopicConfigs"}},"agent_DefaultTopicConfigs":{"required":["default","serverDefaultProperties","description"],"type":"object","properties":{"default":{"type":"string"},"serverDefaultProperties":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_RequestType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RequestType":{"type":"string","enum":["Create","Update","Delete"]}}}}
```

## The agent\_Restore object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Restore":{"type":"object"}}}}
```

## The agent\_RestoreTopicRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RestoreTopicRequest":{"required":["cluster","s3","storageFormat"],"type":"object","properties":{"cluster":{"type":"string"},"s3":{"$ref":"#/components/schemas/agent_S3Bucket"},"storageFormat":{"$ref":"#/components/schemas/agent_S3StorageFormat"}}},"agent_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}},"agent_S3StorageFormat":{"type":"string","enum":["avro","parquet","json"]}}}}
```

## The agent\_Results object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Results":{"required":["datasets"],"type":"object","properties":{"datasets":{"$ref":"#/components/schemas/agent_Page_DatasetMatchWithLrn"},"sourceTypes":{"type":"array","items":{"$ref":"#/components/schemas/agent_SourceType"}}}},"agent_Page_DatasetMatchWithLrn":{"required":["pagesAmount","totalCount"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetMatchWithLrn"}},"pagesAmount":{"type":"integer","format":"int64"},"totalCount":{"type":"integer","format":"int64"}}},"agent_DatasetMatchWithLrn":{"oneOf":[{"$ref":"#/components/schemas/agent_Kafka"},{"$ref":"#/components/schemas/agent_SchemaRegistrySubject"}],"discriminator":{"propertyName":"sourceType","mapping":{"Kafka":"#/components/schemas/agent_Kafka","SchemaRegistrySubject":"#/components/schemas/agent_SchemaRegistrySubject"}}},"agent_Kafka":{"required":["name","recordsPerSecond","keyType","valueType","connectionName","replication","consumers","partitions","isSystemEntity","isMarkedForDeletion","isCompacted","permissions","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"records":{"type":"integer","format":"int64"},"recordsPerSecond":{"type":"integer","format":"int64"},"keyType":{"type":"string"},"valueType":{"type":"string"},"connectionName":{"type":"string"},"replication":{"type":"integer"},"consumers":{"type":"integer"},"partitions":{"type":"integer"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"sizeBytes":{"type":"integer","format":"int64"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"retentionMs":{"type":"integer","format":"int64"},"retentionBytes":{"type":"integer","format":"int64"},"backupRestoreState":{"$ref":"#/components/schemas/agent_BackupRestoreState"},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_BackupRestoreState":{"oneOf":[{"$ref":"#/components/schemas/agent_Backup"},{"$ref":"#/components/schemas/agent_BackupRestore"},{"$ref":"#/components/schemas/agent_Restore"}]},"agent_Backup":{"type":"object"},"agent_BackupRestore":{"type":"object"},"agent_Restore":{"type":"object"},"agent_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaVersion"},"minItems":1},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"agent_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}}}},"agent_SourceType":{"type":"string","enum":["Kafka","SchemaRegistrySubject"]}}}}
```

## The agent\_RetentionConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RetentionConfig":{"required":["size","time"],"type":"object","properties":{"size":{"$ref":"#/components/schemas/agent_DefaultMax"},"time":{"$ref":"#/components/schemas/agent_DefaultMax"}}},"agent_DefaultMax":{"required":["max"],"type":"object","properties":{"default":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Runner object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Runner":{"required":["url"],"type":"object","properties":{"url":{"type":"string","description":"Url of the HealthCheck URL Endpoint"},"name":{"type":"string","description":"Name of the Runner"},"healthCheckInterval":{"type":"integer","description":"How frequently we poll for updates(In ms)","format":"int64"}}}}}}
```

## The agent\_Runner1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Runner1":{"required":["id","worker","status"],"type":"object","properties":{"id":{"type":"string"},"worker":{"type":"string"},"status":{"$ref":"#/components/schemas/agent_AppStateEnum"},"errorMsg":{"type":"string"}}},"agent_AppStateEnum":{"type":"string","enum":["FAILED","STOPPED","RUNNING","UNKNOWN","CREATED","REBALANCING","NOT_RUNNING","WARNING","PENDING"]}}}}
```

## The agent\_RunnerAction object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_RunnerAction":{"type":"string","enum":["Scaled","Stopped","Started","ConfigChange","Recovered"]}}}}
```

## The agent\_S3Bucket object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_S3Bucket":{"required":["bucket"],"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string"}}}}}}
```

## The agent\_S3StorageFormat object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_S3StorageFormat":{"type":"string","enum":["avro","parquet","json"]}}}}
```

## The agent\_SchemaReference object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}}}}}
```

## The agent\_SchemaRegistryConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfiguration"}}},"agent_SchemaRegistryConnectionConfiguration":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"type":"array","items":{"type":"string"},"description":"List of schema registry urls"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"hardDelete":{"type":"boolean","description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfigurationV2"}}},"agent_SchemaRegistryConnectionConfigurationV2":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of schema registry urls"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"hardDelete":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionConfiguration":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"type":"array","items":{"type":"string"},"description":"List of schema registry urls"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"hardDelete":{"type":"boolean","description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionConfigurationV2":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of schema registry urls"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"hardDelete":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_SchemaRegistryConnectionConfiguration":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"type":"array","items":{"type":"string"},"description":"List of schema registry urls"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"hardDelete":{"type":"boolean","description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_SchemaRegistryConnectionConfiguration":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"type":"array","items":{"type":"string"},"description":"List of schema registry urls"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"hardDelete":{"type":"boolean","description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_SchemaRegistryConnectionConfigurationV2":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of schema registry urls"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"hardDelete":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfiguration"}}},"agent_SchemaRegistryConnectionConfiguration":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"type":"array","items":{"type":"string"},"description":"List of schema registry urls"},"username":{"type":"string","description":"Username for HTTP Basic Authentication"},"password":{"type":"string","description":"Password for HTTP Basic Authentication","format":"password"},"sslKeystore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL keystore file"},"sslKeystorePassword":{"type":"string","description":"Password to the keystore","format":"password"},"sslKeyPassword":{"type":"string","description":"Key password for the keystore","format":"password"},"sslTruststore":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}},"description":"SSL truststore file"},"sslTruststorePassword":{"type":"string","description":"Password to the truststore","format":"password"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"hardDelete":{"type":"boolean","description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistryConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistryConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_SchemaRegistryConnectionConfigurationV2"}}},"agent_SchemaRegistryConnectionConfigurationV2":{"required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of schema registry urls"},"username":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Username for HTTP Basic Authentication"},"password":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password for HTTP Basic Authentication"},"sslKeystore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL keystore file"},"sslKeystorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the keystore"},"sslKeyPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Key password for the keystore"},"sslTruststore":{"required":["value"],"type":"object","properties":{"value":{"required":["fileId"],"type":"object","properties":{"fileId":{"type":"string","format":"uuid"}}}},"description":"SSL truststore file"},"sslTruststorePassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"Password to the truststore"},"additionalProperties":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}}},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"hardDelete":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Enables Schema Registry hard delete"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_SchemaRegistrySubject object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaRegistrySubject":{"required":["name","connectionName","isSystemEntity","permissions","format","version","schemaId","lrn","sourceType"],"type":"object","properties":{"name":{"type":"string"},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"sizeBytes":{"type":"integer","format":"int64"},"records":{"type":"integer","format":"int64"},"connectionName":{"type":"string"},"fields":{"$ref":"#/components/schemas/agent_Fields"},"isSystemEntity":{"type":"boolean"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyMatchDetailsWithLrn"}},"permissions":{"type":"array","items":{"type":"string"},"minItems":1},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"format":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"schemaId":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}},"compatibility":{"type":"string"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaVersion"},"minItems":1},"lrn":{"type":"string"},"sourceType":{"type":"string"}}},"agent_Highlight":{"required":["fieldName","startIndex","endIndex","arrayIndex"],"type":"object","properties":{"fieldName":{"type":"string"},"startIndex":{"type":"integer"},"endIndex":{"type":"integer"},"arrayIndex":{"type":"integer"}}},"agent_Fields":{"type":"object","properties":{"key":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}},"value":{"type":"array","items":{"$ref":"#/components/schemas/agent_Field"}}}},"agent_Field":{"required":["name","typeDetails","isNullable"],"type":"object","properties":{"name":{"type":"string"},"typeDetails":{"$ref":"#/components/schemas/agent_FieldTypeDetails"},"description":{"type":"string"},"ancestors":{"type":"array","items":{"type":"string"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/agent_Highlight"}},"isNullable":{"type":"boolean"},"default":{"type":"string"}}},"agent_FieldTypeDetails":{"oneOf":[{"$ref":"#/components/schemas/agent_Lenses"},{"$ref":"#/components/schemas/agent_Native"}]},"agent_Lenses":{"required":["lensesDataType"],"type":"object","properties":{"lensesDataType":{"type":"string"}}},"agent_Native":{"required":["native","lensesDataType"],"type":"object","properties":{"native":{"type":"string"},"lensesDataType":{"type":"string"}}},"agent_PolicyMatchDetailsWithLrn":{"required":["policyId","policyName","policyCategory","obfuscation","lrn"],"type":"object","properties":{"policyId":{"type":"string"},"policyName":{"type":"string"},"policyCategory":{"type":"string"},"obfuscation":{"type":"string"},"matchingKeyFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"matchingValueFields":{"type":"array","items":{"$ref":"#/components/schemas/agent_PolicyFieldMatch"}},"lrn":{"type":"string"}}},"agent_PolicyFieldMatch":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}},"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}},"agent_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}}}}}}}
```

## The agent\_SchemaVersion object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SchemaVersion":{"required":["id","version","schema","format"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"schema":{"type":"string"},"format":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/agent_SchemaReference"}}}},"agent_SchemaReference":{"required":["subjectName","schemaName","version"],"type":"object","properties":{"subjectName":{"type":"string"},"schemaName":{"type":"string"},"version":{"type":"integer"}}}}}}
```

## The agent\_SetConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetConfig":{"required":["compatibility"],"type":"object","properties":{"compatibility":{"type":"string"}}}}}}
```

## The agent\_SetDescription object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetDescription":{"type":"object","properties":{"description":{"type":"string"}}}}}}
```

## The agent\_SetDescriptionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetDescriptionRequest":{"type":"object","properties":{"description":{"type":"string","minLength":1}}}}}}
```

## The agent\_SetLogLevelRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetLogLevelRequest":{"required":["loggerName","level"],"type":"object","properties":{"loggerName":{"type":"string"},"level":{"$ref":"#/components/schemas/agent_LogLevel"}}},"agent_LogLevel":{"type":"string","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"]}}}}
```

## The agent\_SetLogLevelResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetLogLevelResponse":{"required":["loggerName","newLevel"],"type":"object","properties":{"loggerName":{"type":"string"},"previousLevel":{"type":"string"},"newLevel":{"type":"string"}}}}}}
```

## The agent\_SetTags object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetTags":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag1"}}}},"agent_DatasetTag1":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The agent\_SetTagsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetTagsRequest":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string","minLength":1}}}}}}}
```

## The agent\_SetTopicConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetTopicConfiguration":{"type":"object","properties":{"configs":{"type":"array","items":{"$ref":"#/components/schemas/agent_TopicConfigKeyValue"}}}},"agent_TopicConfigKeyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The agent\_SetTopicPolicy object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SetTopicPolicy":{"required":["config"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/agent_TopicPolicyConfig"},"naming":{"$ref":"#/components/schemas/agent_NamingStrategy"}}},"agent_TopicPolicyConfig":{"required":["partitions","replication","retention"],"type":"object","properties":{"partitions":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"replication":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"retention":{"$ref":"#/components/schemas/agent_RetentionConfig"}}},"agent_MinMaybeMax":{"required":["min"],"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"agent_RetentionConfig":{"required":["size","time"],"type":"object","properties":{"size":{"$ref":"#/components/schemas/agent_DefaultMax"},"time":{"$ref":"#/components/schemas/agent_DefaultMax"}}},"agent_DefaultMax":{"required":["max"],"type":"object","properties":{"default":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}},"agent_NamingStrategy":{"required":["pattern","description"],"type":"object","properties":{"pattern":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_Settings object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}}}}}
```

## The agent\_SinglePartitionOffsetRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SinglePartitionOffsetRequest":{"oneOf":[{"$ref":"#/components/schemas/agent_Absolute"},{"$ref":"#/components/schemas/agent_End"},{"$ref":"#/components/schemas/agent_Start"}]},"agent_Absolute":{"required":["offset"],"type":"object","properties":{"offset":{"type":"integer","format":"int64"}}},"agent_End":{"type":"object"},"agent_Start":{"type":"object"}}}}
```

## The agent\_SourceType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SourceType":{"type":"string","enum":["Kafka","SchemaRegistrySubject"]}}}}
```

## The agent\_SqlProcessorType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SqlProcessorType":{"type":"string","enum":["PreDaD","DaD"]}}}}
```

## The agent\_Start object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Start":{"type":"object"}}}}
```

## The agent\_Start1 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Start1":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The agent\_StatementPos object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_StatementPos":{"required":["index","start","end"],"type":"object","properties":{"index":{"type":"integer"},"start":{"type":"integer"},"end":{"type":"integer"}}}}}}
```

## The agent\_Suggestion object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Suggestion":{"required":["display","text","start","end","type","highlightStart","highlightEnd"],"type":"object","properties":{"display":{"type":"string"},"text":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"},"type":{"type":"string"},"description":{"type":"string"},"highlightStart":{"type":"integer"},"highlightEnd":{"type":"integer"}}}}}}
```

## The agent\_SuitableConnection object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SuitableConnection":{"required":["templateName","name"],"type":"object","properties":{"templateName":{"type":"string"},"name":{"type":"string"}}}}}}
```

## The agent\_TableFields object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TableFields":{"required":["tableName"],"type":"object","properties":{"tableName":{"$ref":"#/components/schemas/agent_TableName"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldName"}}}},"agent_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}},"agent_FieldName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The agent\_TableMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TableMetadata":{"required":["topicName","keyType","valueType"],"type":"object","properties":{"topicName":{"type":"string"},"keyType":{"type":"string"},"valueType":{"type":"string"},"keySchema":{"type":"string"},"keySchemaVersion":{"type":"integer"},"keySchemaInlined":{"type":"string"},"valueSchema":{"type":"string"},"valueSchemaVersion":{"type":"integer"},"valueSchemaInlined":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"additionalInfo":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{}}}}
```

## The agent\_TableName object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TableName":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}}}}}}
```

## The agent\_TableProperty object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TableProperty":{"required":["name","isDefault"],"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"},"defaultValue":{"type":"string"},"documentation":{"type":"string"},"originalValue":{"type":"string"}}}}}}
```

## The agent\_TagCount object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TagCount":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_TagCounts object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TagCounts":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_TagCount"}}}},"agent_TagCount":{"required":["name","count"],"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_Target object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Target":{"required":["cluster"],"type":"object","properties":{"cluster":{"type":"string"},"version":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_TaskDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TaskDetails":{"required":["id","state","workerId"],"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string"},"workerId":{"type":"string"},"trace":{"type":"string"}}}}}}
```

## The agent\_TemplateCategory object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TemplateCategory":{"type":"string","enum":["Connection","Application","Channel","Deployment"]}}}}
```

## The agent\_TemplateMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TemplateMetadata":{"required":["author"],"type":"object","properties":{"author":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_TemplateProperty object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TemplateProperty":{"required":["id","key","displayName","type","required","provided"],"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"displayName":{"type":"string"},"placeholder":{"type":"string"},"description":{"type":"string"},"type":{"$ref":"#/components/schemas/agent_TemplatePropertyType"},"required":{"type":"boolean"},"provided":{"type":"boolean"}}},"agent_TemplatePropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"},"enumValues":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]}}}}
```

## The agent\_TemplatePropertyType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TemplatePropertyType":{"required":["name","displayName"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_KeyDataType"},"displayName":{"type":"string"},"enumValues":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_KeyDataType":{"type":"string","description":"The data type of the property","enum":["STRING","ARRAY","MULTILINE","SECRET","DOUBLE","LONG","BOOLEAN","BASE64","ENUM","MAP"]}}}}
```

## The agent\_TemplateType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TemplateType":{"type":"string","enum":["Not Applicable","SQLRunner","Kubernetes","InProc","Connect","Alert Channel","Audit Channel","SchemaRegistry"]}}}}
```

## The agent\_TestConnectionApiRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TestConnectionApiRequestV2":{"required":["name","templateName"],"type":"object","properties":{"name":{"type":"string"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection","minLength":1},"configuration":{"type":"object","description":"The configuration of the connection. The schema of this object is defined by the [template configuration](#operation/listConnectionTemplates)"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}}}}}
```

## The agent\_Timestamp object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Timestamp":{"required":["target"],"type":"object","properties":{"target":{"type":"string","format":"date-time"},"topics":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}
```

## The agent\_TopicApiDetails object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicApiDetails":{"required":["name","keyFormat","valueFormat"],"type":"object","properties":{"name":{"type":"string","minLength":1},"keyFormat":{"$ref":"#/components/schemas/agent_DecoderType"},"valueFormat":{"$ref":"#/components/schemas/agent_DecoderType"}}},"agent_DecoderType":{"type":"string","description":"A lenses format decoder or a fully qualified custom serde class name","enum":["TWAVRO","SWBYTES","XML","TWPROTOBUF","SWXML","TWJSON","SWPROTOBUF","TWXML","INT","PROTOBUF","TWBYTES","TWINT","LONG","SWAVRO","SWINT","JSON","SWSTRING","SWJSON","BYTES","CSV","AVRO","STRING","SWLONG","TWSTRING","TWLONG"]}}}}
```

## The agent\_TopicConfigKeyValue object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicConfigKeyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The agent\_TopicField object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicField":{"type":"string","enum":["topicName","partitions","replication","isControlTopic","keyType","valueType","totalMessages","configs","consumers","messagesPerSecond","isMarkedForDeletion","isCompacted"]}}}}
```

## The agent\_TopicPage\_HttpShortTopicSummary object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicPage_HttpShortTopicSummary":{"required":["pageCount","totalTopicCount"],"type":"object","properties":{"topics":{"type":"array","items":{"$ref":"#/components/schemas/agent_HttpShortTopicSummary"}},"pageCount":{"type":"integer","format":"int64"},"totalTopicCount":{"type":"integer","format":"int64"}}},"agent_HttpShortTopicSummary":{"required":["topicName","lrn","partitions","replication","isControlTopic","keyType","valueType","totalMessages","configs","consumers","messagesPerSecond","isMarkedForDeletion","isCompacted"],"type":"object","properties":{"topicName":{"type":"string"},"lrn":{"type":"string"},"partitions":{"type":"integer"},"replication":{"type":"integer"},"isControlTopic":{"type":"boolean"},"keyType":{"type":"string"},"valueType":{"type":"string"},"totalMessages":{"type":"integer","format":"int64"},"configs":{"type":"integer"},"consumers":{"type":"integer"},"messagesPerSecond":{"type":"integer","format":"int64"},"isMarkedForDeletion":{"type":"boolean"},"isCompacted":{"type":"boolean"},"description":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/agent_DatasetTag"}},"size":{"type":"integer","format":"int64"}}},"agent_DatasetTag":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The agent\_TopicPolicy object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicPolicy":{"required":["config","isApplicable"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/agent_TopicPolicyConfig"},"naming":{"$ref":"#/components/schemas/agent_NamingStrategy"},"isApplicable":{"type":"boolean"}}},"agent_TopicPolicyConfig":{"required":["partitions","replication","retention"],"type":"object","properties":{"partitions":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"replication":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"retention":{"$ref":"#/components/schemas/agent_RetentionConfig"}}},"agent_MinMaybeMax":{"required":["min"],"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"agent_RetentionConfig":{"required":["size","time"],"type":"object","properties":{"size":{"$ref":"#/components/schemas/agent_DefaultMax"},"time":{"$ref":"#/components/schemas/agent_DefaultMax"}}},"agent_DefaultMax":{"required":["max"],"type":"object","properties":{"default":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}},"agent_NamingStrategy":{"required":["pattern","description"],"type":"object","properties":{"pattern":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The agent\_TopicPolicyConfig object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicPolicyConfig":{"required":["partitions","replication","retention"],"type":"object","properties":{"partitions":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"replication":{"$ref":"#/components/schemas/agent_MinMaybeMax"},"retention":{"$ref":"#/components/schemas/agent_RetentionConfig"}}},"agent_MinMaybeMax":{"required":["min"],"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"agent_RetentionConfig":{"required":["size","time"],"type":"object","properties":{"size":{"$ref":"#/components/schemas/agent_DefaultMax"},"time":{"$ref":"#/components/schemas/agent_DefaultMax"}}},"agent_DefaultMax":{"required":["max"],"type":"object","properties":{"default":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}}
```

## The agent\_TopicSchema object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopicSchema":{"type":"object","properties":{"schema":{"type":"string"},"version":{"type":"integer"},"inlinedSchema":{"type":"string"}}}}}}
```

## The agent\_TopologyNodeType object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_TopologyNodeType":{"type":"string","enum":["STREAM","TOPIC","TABLE","SELECT","FILTER","JOIN","GROUPBY","AGGREGATE","COUNT","REPARTITION","MAP","FLATMAP","SINK","SOURCE","PROCESSOR"]}}}}
```

## The agent\_Unauthorized object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_Unauthorized":{"required":["error"],"type":"object","properties":{"error":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/agent_FieldError"}},"errorType":{"type":"string"}}},"agent_FieldError":{"required":["field","error"],"type":"object","properties":{"field":{"type":"string"},"error":{"type":"string"},"lineNumber":{"type":"integer"},"columnNumber":{"type":"integer"}}}}}}
```

## The agent\_UpdateChannelApiEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UpdateChannelApiEntity":{"required":["name","connectionName"],"type":"object","properties":{"name":{"type":"string"},"connectionName":{"type":"string"},"enabled":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/agent_PropertyValue"}},"propertiesObject":{"$ref":"#/components/schemas/agent_JsonObject"}}},"agent_PropertyValue":{"required":["key","value"],"type":"object","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/agent_Json"}}},"agent_Json":{},"agent_JsonObject":{"type":"object","description":"JSON Schema representation of the configuration properties"}}}}
```

## The agent\_UpdateExistingEntity object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UpdateExistingEntity":{"required":["entityName","entityType","metadata","settings"],"type":"object","properties":{"entityName":{"type":"string"},"entityType":{"$ref":"#/components/schemas/agent_EntityType"},"metadata":{"$ref":"#/components/schemas/agent_Metadata"},"settings":{"$ref":"#/components/schemas/agent_Settings"}}},"agent_EntityType":{"type":"string","enum":["KafkaTopic"]},"agent_Metadata":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"agent_Settings":{"required":["replication","partitions","capacity"],"type":"object","properties":{"replication":{"type":"integer"},"partitions":{"type":"integer"},"topicConfig":{"type":"object","additionalProperties":{"type":"string"}},"capacity":{"$ref":"#/components/schemas/agent_Capacity"}}},"agent_Capacity":{"type":"object","properties":{"recordsSize":{"type":"integer"},"dataProducedPerDay":{"type":"integer"},"consumers":{"type":"integer"}}}}}}
```

## The agent\_UpdatePolicyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UpdatePolicyRequest":{"required":["id","name","category","impactType","obfuscation"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"impactType":{"$ref":"#/components/schemas/agent_ImpactType"},"obfuscation":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"datasets":{"type":"array","items":{"type":"string"},"minItems":1}}},"agent_ImpactType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]}}}}
```

## The agent\_UpsertConnectionApiRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UpsertConnectionApiRequestV2":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"templateName":{"type":"string","minLength":1},"configuration":{"type":"object"}}}}}}
```

## The agent\_UsedFormatsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UsedFormatsResponse":{"type":"object","properties":{"formats":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ViewStateAPIResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ViewStateAPIResponse":{"required":["connections"],"type":"object","properties":{"connections":{"$ref":"#/components/schemas/agent_Map_String_List_ConnectionStateResponse"}}},"agent_Map_String_List_ConnectionStateResponse":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConnectionStateResponse"}}},"agent_ConnectionStateResponse":{"required":["name","version"],"type":"object","properties":{"name":{"type":"string"},"version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}}}}}}}
```

## The agent\_ZookeeperConnectionAddRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionAddRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfiguration"}}},"agent_ZookeeperConnectionConfiguration":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"type":"array","items":{"type":"string"},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"type":"string","description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"type":"integer","description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"type":"integer","description":"Zookeeper connection timeout"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionAddRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionAddRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfigurationV2"}}},"agent_ZookeeperConnectionConfigurationV2":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection timeout"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionConfiguration":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"type":"array","items":{"type":"string"},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"type":"string","description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"type":"integer","description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"type":"integer","description":"Zookeeper connection timeout"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionConfigurationV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionConfigurationV2":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection timeout"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionResponse object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionResponse":{"required":["name","lrn","templateVersion","templateName","builtIn","createdBy","createdAt","modifiedBy","modifiedAt","configurationObject","deletable"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"lrn":{"type":"string"},"templateVersion":{"type":"integer"},"templateName":{"type":"string","description":"The [template](#operation/listConnectionTemplates) of the connection"},"builtIn":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"configurationObject":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfiguration"},"tags":{"type":"array","items":{"type":"string"}},"deletable":{"type":"boolean"}}},"agent_ZookeeperConnectionConfiguration":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"type":"array","items":{"type":"string"},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"type":"string","description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"type":"integer","description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"type":"integer","description":"Zookeeper connection timeout"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionTestRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionTestRequest":{"required":["name","configurationObject"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configurationObject":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfiguration"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_ZookeeperConnectionConfiguration":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"type":"array","items":{"type":"string"},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"type":"string","description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"type":"integer","description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"type":"integer","description":"Zookeeper connection timeout"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionTestRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionTestRequestV2":{"required":["name","configuration"],"type":"object","properties":{"name":{"type":"string","description":"Name of the connection"},"configuration":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfigurationV2"},"update":{"type":"boolean","description":"*true* if testing an update to an existing connection, *false* if testing a new connection"}}},"agent_ZookeeperConnectionConfigurationV2":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection timeout"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionUpsertRequest":{"required":["configurationObject"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configurationObject":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfiguration"}}},"agent_ZookeeperConnectionConfiguration":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"type":"array","items":{"type":"string"},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"type":"string","description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"type":"integer","description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"type":"integer","description":"Zookeeper connection timeout"},"metricsType":{"type":"string","description":"Metrics type","enum":["JMX","JOLOKIAG","JOLOKIAP"]},"metricsPort":{"type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"type":"string","description":"The username for metrics connections"},"metricsPassword":{"type":"string","description":"The password for metrics connections","format":"password"},"metricsSsl":{"type":"boolean","description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"type":"string","description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"type":"integer","description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}},"metricsCustomPortMappings":{"type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}},"metricsRateLimitingMaxRetries":{"type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ZookeeperConnectionUpsertRequestV2 object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperConnectionUpsertRequestV2":{"required":["configuration"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"configuration":{"$ref":"#/components/schemas/agent_ZookeeperConnectionConfigurationV2"}}},"agent_ZookeeperConnectionConfigurationV2":{"required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"required":["value"],"type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}},"description":"List of zookeeper urls"},"zookeeperChrootPath":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"Zookeeper /znode path"},"zookeeperSessionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection session timeout"},"zookeeperConnectionTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Zookeeper connection timeout"},"metricsType":{"required":["value"],"type":"object","properties":{"value":{"type":"string","enum":["JMX","JOLOKIAG","JOLOKIAP"]}},"description":"Metrics type"},"metricsPort":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"Default port number for metrics connection (JMX and JOLOKIA)"},"metricsUsername":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"The username for metrics connections"},"metricsPassword":{"required":["value"],"type":"object","properties":{"value":{"type":"string","format":"password"}},"description":"The password for metrics connections"},"metricsSsl":{"required":["value"],"type":"object","properties":{"value":{"type":"boolean"}},"description":"Flag to enable SSL for metrics connections"},"metricsHttpSuffix":{"required":["value"],"type":"object","properties":{"value":{"type":"string"}},"description":"HTTP URL suffix for Jolokia metrics"},"metricsHttpTimeout":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP Request timeout (ms) for Jolokia metrics"},"metricsCustomUrlMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis"},"metricsCustomPortMappings":{"required":["value"],"type":"object","properties":{"value":{"type":"object","additionalProperties":{"type":"string"}}},"description":"DEPRECATED"},"metricsRateLimitingMaxRetries":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"HTTP retries when 429 is returned for Jolokia metrics"},"metricsRateLimitingBackoff":{"required":["value"],"type":"object","properties":{"value":{"type":"integer"}},"description":"The backoff interval (ms) when 429 is returned for Jolokia metrics"}}}}}}
```

## The agent\_ProvisioningReferenceable object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_KafkaProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaProvisioningConfiguration":{"title":"Kafka connection configuration","required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"title":"Kafka Bootstrap Servers","description":"Comma separated list of protocol://host:port to use for initial connection to Kafka.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kafka Bootstrap Servers","type":"array","items":{"type":"string","minLength":1},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"protocol":{"title":"Security protocol","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Security protocol","type":"string","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslMechanism":{"title":"SASL Mechanism","description":"Mechanism to use when authenticated using SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Mechanism","type":"string","description":"Mechanism to use when authenticated using SASL","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslJaasConfig":{"title":"SASL Jaas config","description":"JAAS Login module configuration for SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Jaas config","type":"string","description":"JAAS Login module configuration for SASL","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"keytab":{"title":"Keytab file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded contents of the keytab file"},"additionalProperties":{"title":"Additional properties for Kafka connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Kafka connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["AWS","JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: BrokerId -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"kafkaConnectivityTimeout":{"title":"Connectivity check timeout","description":"Timeout (ms) for the Test Connection connectivity check","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Connectivity check timeout","type":"integer","description":"Timeout (ms) for the Test Connection connectivity check","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Apache Kafka"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_KafkaProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KafkaProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_KafkaProvisioningConfiguration":{"title":"Kafka connection configuration","required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"title":"Kafka Bootstrap Servers","description":"Comma separated list of protocol://host:port to use for initial connection to Kafka.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kafka Bootstrap Servers","type":"array","items":{"type":"string","minLength":1},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"protocol":{"title":"Security protocol","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Security protocol","type":"string","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslMechanism":{"title":"SASL Mechanism","description":"Mechanism to use when authenticated using SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Mechanism","type":"string","description":"Mechanism to use when authenticated using SASL","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslJaasConfig":{"title":"SASL Jaas config","description":"JAAS Login module configuration for SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Jaas config","type":"string","description":"JAAS Login module configuration for SASL","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"keytab":{"title":"Keytab file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded contents of the keytab file"},"additionalProperties":{"title":"Additional properties for Kafka connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Kafka connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["AWS","JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: BrokerId -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"kafkaConnectivityTimeout":{"title":"Connectivity check timeout","description":"Timeout (ms) for the Test Connection connectivity check","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Connectivity check timeout","type":"integer","description":"Timeout (ms) for the Test Connection connectivity check","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Apache Kafka"}}}}
```

## The agent\_ConfluentSchemaRegistryProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConfluentSchemaRegistryProvisioningConfiguration":{"title":"SchemaRegistry connection configuration","required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"title":"urls","description":"List of schema registry urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of schema registry urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"additionalProperties":{"title":"Additional properties for Schema Registry connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Schema Registry connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"hardDelete":{"title":"Hard Delete","description":"Enables Schema Registry hard delete","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Hard Delete","type":"boolean","description":"Enables Schema Registry hard delete"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Schema registries"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_ConfluentSchemaRegistryProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ConfluentSchemaRegistryProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_ConfluentSchemaRegistryProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_ConfluentSchemaRegistryProvisioningConfiguration":{"title":"SchemaRegistry connection configuration","required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"title":"urls","description":"List of schema registry urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of schema registry urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"additionalProperties":{"title":"Additional properties for Schema Registry connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Schema Registry connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"hardDelete":{"title":"Hard Delete","description":"Enables Schema Registry hard delete","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Hard Delete","type":"boolean","description":"Enables Schema Registry hard delete"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Schema registries"}}}}
```

## The agent\_GlueSchemaRegistryProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_GlueSchemaRegistryProvisioningConfiguration":{"title":"AWSGlueSchemaRegistry connection configuration","required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"title":"ARN","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"ARN","type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheTtl":{"title":"Cache time to live","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache time to live","type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheSize":{"title":"Cache size","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache size","type":"integer","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryDefaultCompatibility":{"title":"Default compatibility mode to use on Schema creation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default compatibility mode to use on Schema creation","type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS Glue Schema registry"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_GlueSchemaRegistryProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_GlueSchemaRegistryProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_GlueSchemaRegistryProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_GlueSchemaRegistryProvisioningConfiguration":{"title":"AWSGlueSchemaRegistry connection configuration","required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"title":"ARN","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"ARN","type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheTtl":{"title":"Cache time to live","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache time to live","type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheSize":{"title":"Cache size","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache size","type":"integer","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryDefaultCompatibility":{"title":"Default compatibility mode to use on Schema creation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default compatibility mode to use on Schema creation","type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS Glue Schema registry"}}}}
```

## The agent\_KafkaConnectProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectProvisioningConfiguration":{"title":"KafkaConnect connection configuration","required":["workers"],"type":"object","properties":{"workers":{"title":"workers","description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used ","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"workers","type":"array","items":{"type":"string","minLength":1},"description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used "}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"aes256Key":{"title":"AES256 Key for Connector Secrets","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"AES256 Key for Connector Secrets","type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Kafka Connect cluster connection."},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_KafkaConnectProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KafkaConnectProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_KafkaConnectProvisioningConfiguration":{"title":"KafkaConnect connection configuration","required":["workers"],"type":"object","properties":{"workers":{"title":"workers","description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used ","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"workers","type":"array","items":{"type":"string","minLength":1},"description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used "}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"aes256Key":{"title":"AES256 Key for Connector Secrets","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"AES256 Key for Connector Secrets","type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Kafka Connect cluster connection."}}}}
```

## The agent\_ZookeeperProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperProvisioningConfiguration":{"title":"Zookeeper connection configuration","required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"title":"urls","description":"List of zookeeper urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of zookeeper urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperChrootPath":{"title":"Zookeeper /znode path","description":"Zookeeper /znode path","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper /znode path","type":"string","description":"Zookeeper /znode path"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperSessionTimeout":{"title":"Zookeeper connection session timeout (ms)","description":"Zookeeper connection session timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection session timeout (ms)","type":"integer","description":"Zookeeper connection session timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperConnectionTimeout":{"title":"Zookeeper connection timeout (ms)","description":"Zookeeper connection timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection timeout (ms)","type":"integer","description":"Zookeeper connection timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Zookeeper"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_ZookeeperProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_ZookeeperProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_ZookeeperProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_ZookeeperProvisioningConfiguration":{"title":"Zookeeper connection configuration","required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"title":"urls","description":"List of zookeeper urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of zookeeper urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperChrootPath":{"title":"Zookeeper /znode path","description":"Zookeeper /znode path","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper /znode path","type":"string","description":"Zookeeper /znode path"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperSessionTimeout":{"title":"Zookeeper connection session timeout (ms)","description":"Zookeeper connection session timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection session timeout (ms)","type":"integer","description":"Zookeeper connection session timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperConnectionTimeout":{"title":"Zookeeper connection timeout (ms)","description":"Zookeeper connection timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection timeout (ms)","type":"integer","description":"Zookeeper connection timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Zookeeper"}}}}
```

## The agent\_KerberosProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosProvisioningConfiguration":{"title":"Kerberos connection configuration","required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"title":"Kerberos krb5 config","description":"Kerberos krb5.conf file","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kerberos krb5 config","type":"string","description":"Kerberos krb5.conf file"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Kerberos server"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_KerberosProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_KerberosProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KerberosProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_KerberosProvisioningConfiguration":{"title":"Kerberos connection configuration","required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"title":"Kerberos krb5 config","description":"Kerberos krb5.conf file","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kerberos krb5 config","type":"string","description":"Kerberos krb5.conf file"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Kerberos server"}}}}
```

## The agent\_AWSProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSProvisioningConfiguration":{"title":"AWS connection configuration","required":["authMode"],"type":"object","properties":{"accessKeyId":{"title":"Access Key ID","description":"Access key ID of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Access Key ID","type":"string","description":"Access key ID of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"secretAccessKey":{"title":"Secret Access Key","description":"Secret access key of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Secret Access Key","type":"string","description":"Secret access key of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"region":{"title":"Region","description":"AWS region to connect to. If not provided, this is deferred to client configuration.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Region","type":"string","description":"AWS region to connect to. If not provided, this is deferred to client configuration."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sessionToken":{"title":"Session token","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Session token","type":"string","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"authMode":{"title":"Authentication mode","description":"Way to authenticate against AWS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Authentication mode","type":"string","description":"Way to authenticate against AWS","enum":["Access Key","Credentials Chain","Assume Role"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleArn":{"title":"Role ARN","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role ARN","type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleSessionName":{"title":"Role Session Name","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role Session Name","type":"string","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS IAM account"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_AWSProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AWSProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_AWSProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_AWSProvisioningConfiguration":{"title":"AWS connection configuration","required":["authMode"],"type":"object","properties":{"accessKeyId":{"title":"Access Key ID","description":"Access key ID of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Access Key ID","type":"string","description":"Access key ID of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"secretAccessKey":{"title":"Secret Access Key","description":"Secret access key of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Secret Access Key","type":"string","description":"Secret access key of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"region":{"title":"Region","description":"AWS region to connect to. If not provided, this is deferred to client configuration.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Region","type":"string","description":"AWS region to connect to. If not provided, this is deferred to client configuration."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sessionToken":{"title":"Session token","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Session token","type":"string","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"authMode":{"title":"Authentication mode","description":"Way to authenticate against AWS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Authentication mode","type":"string","description":"Way to authenticate against AWS","enum":["Access Key","Credentials Chain","Assume Role"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleArn":{"title":"Role ARN","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role ARN","type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleSessionName":{"title":"Role Session Name","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role Session Name","type":"string","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS IAM account"}}}}
```

## The agent\_PostgresProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PostgresProvisioningConfiguration":{"title":"PostgreSQL connection configuration","required":["host","port","database","username","sslMode"],"type":"object","properties":{"host":{"title":"Host","description":"The Postgres hostname","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Host","type":"string","description":"The Postgres hostname"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"Port","description":"The port number","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Port","type":"integer","description":"The port number","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"database":{"title":"Database name","description":"The database to connect to","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Database name","type":"string","description":"The database to connect to"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"User name","description":"The user name","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"User name","type":"string","description":"The user name"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"The password","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"The password","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslMode":{"title":"SSL Mode","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL Mode","type":"string","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","enum":["disable","allow","prefer","require","verify-ca","verify-full"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"PostgreSQL Connection"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_PostgresProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PostgresProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_PostgresProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_PostgresProvisioningConfiguration":{"title":"PostgreSQL connection configuration","required":["host","port","database","username","sslMode"],"type":"object","properties":{"host":{"title":"Host","description":"The Postgres hostname","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Host","type":"string","description":"The Postgres hostname"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"Port","description":"The port number","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Port","type":"integer","description":"The port number","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"database":{"title":"Database name","description":"The database to connect to","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Database name","type":"string","description":"The database to connect to"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"User name","description":"The user name","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"User name","type":"string","description":"The user name"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"The password","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"The password","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslMode":{"title":"SSL Mode","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL Mode","type":"string","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","enum":["disable","allow","prefer","require","verify-ca","verify-full"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"PostgreSQL Connection"}}}}
```

## The agent\_AlertManagerProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertManagerProvisioningConfiguration":{"title":"PrometheusAlertmanager connection configuration","required":["source","generator-url","ssl"],"type":"object","properties":{"source":{"title":"Source","description":"The Lenses instance raising the alert.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"The Lenses instance raising the alert."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"generator-url":{"title":"Generator URL","description":"A URL to identify the source.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Generator URL","type":"string","description":"A URL to identify the source."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"ssl":{"title":"SSL","description":"If true it enables SSL.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL","type":"boolean","description":"If true it enables SSL."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"publish-interval":{"title":"Publish Interval","description":"The interval in milliseconds to send the alerts raised to Alert manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Publish Interval","type":"integer","description":"The interval in milliseconds to send the alerts raised to Alert manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-connect-timeout":{"title":"HTTP Connection timeout","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Connection timeout","type":"integer","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-request-timeout":{"title":"HTTP Request timeout","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-socket-timeout":{"title":"HTTP socket timeout","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP socket timeout","type":"integer","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Prometheus Alert Manager Channel."},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_AlertManagerProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_AlertManagerProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_AlertManagerProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_AlertManagerProvisioningConfiguration":{"title":"PrometheusAlertmanager connection configuration","required":["source","generator-url","ssl"],"type":"object","properties":{"source":{"title":"Source","description":"The Lenses instance raising the alert.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"The Lenses instance raising the alert."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"generator-url":{"title":"Generator URL","description":"A URL to identify the source.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Generator URL","type":"string","description":"A URL to identify the source."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"ssl":{"title":"SSL","description":"If true it enables SSL.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL","type":"boolean","description":"If true it enables SSL."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"publish-interval":{"title":"Publish Interval","description":"The interval in milliseconds to send the alerts raised to Alert manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Publish Interval","type":"integer","description":"The interval in milliseconds to send the alerts raised to Alert manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-connect-timeout":{"title":"HTTP Connection timeout","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Connection timeout","type":"integer","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-request-timeout":{"title":"HTTP Request timeout","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-socket-timeout":{"title":"HTTP socket timeout","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP socket timeout","type":"integer","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Prometheus Alert Manager Channel."}}}}
```

## The agent\_WebhookProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_WebhookProvisioningConfiguration":{"title":"Webhook connection configuration","required":["method","insecure"],"type":"object","properties":{"method":{"title":"HTTP method","description":"The HTTP method to use.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP method","type":"string","description":"The HTTP method to use.","enum":["POST","PUT","PATCH","GET","DELETE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"path":{"title":"Request path","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Request path","type":"string","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"headers":{"title":"HTTP Headers","description":"A list of HTTP header strings. Supports audit-variable interpolation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Headers","type":"array","items":{"type":"string"},"description":"A list of HTTP header strings. Supports audit-variable interpolation"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"body":{"title":"Body payload","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Body payload","type":"string","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"insecure":{"title":"Disable SSL certificate verification","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Disable SSL certificate verification","type":"boolean","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Web Hook Channel"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_WebhookProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_WebhookProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_WebhookProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_WebhookProvisioningConfiguration":{"title":"Webhook connection configuration","required":["method","insecure"],"type":"object","properties":{"method":{"title":"HTTP method","description":"The HTTP method to use.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP method","type":"string","description":"The HTTP method to use.","enum":["POST","PUT","PATCH","GET","DELETE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"path":{"title":"Request path","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Request path","type":"string","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"headers":{"title":"HTTP Headers","description":"A list of HTTP header strings. Supports audit-variable interpolation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Headers","type":"array","items":{"type":"string"},"description":"A list of HTTP header strings. Supports audit-variable interpolation"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"body":{"title":"Body payload","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Body payload","type":"string","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"insecure":{"title":"Disable SSL certificate verification","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Disable SSL certificate verification","type":"boolean","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Web Hook Channel"}}}}
```

## The agent\_SlackProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SlackProvisioningConfiguration":{"title":"Slack connection configuration","required":["username","channel"],"type":"object","properties":{"username":{"title":"Slack username","description":"The user name to appear in slack as the sender.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack username","type":"string","description":"The user name to appear in slack as the sender."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"channel":{"title":"Slack channel","description":"The Slack channel send alerts to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack channel","type":"string","description":"The Slack channel send alerts to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"icon-url":{"title":"Icon URL","description":"The full path to an image to set for the slack message.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Icon URL","type":"string","description":"The full path to an image to set for the slack message."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Slack Alert Channel"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_SlackProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SlackProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_SlackProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_SlackProvisioningConfiguration":{"title":"Slack connection configuration","required":["username","channel"],"type":"object","properties":{"username":{"title":"Slack username","description":"The user name to appear in slack as the sender.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack username","type":"string","description":"The user name to appear in slack as the sender."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"channel":{"title":"Slack channel","description":"The Slack channel send alerts to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack channel","type":"string","description":"The Slack channel send alerts to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"icon-url":{"title":"Icon URL","description":"The full path to an image to set for the slack message.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Icon URL","type":"string","description":"The full path to an image to set for the slack message."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Slack Alert Channel"}}}}
```

## The agent\_PagerDutyProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PagerDutyProvisioningConfiguration":{"title":"PagerDuty connection configuration","type":"object","description":"PagerDuty Alert Channel"}}}}
```

## The agent\_PagerDutyProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_PagerDutyProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_PagerDutyProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_PagerDutyProvisioningConfiguration":{"title":"PagerDuty connection configuration","type":"object","description":"PagerDuty Alert Channel"}}}}
```

## The agent\_DataDogProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DataDogProvisioningConfiguration":{"title":"DataDog connection configuration","type":"object","description":"Datadog event stream Channel"}}}}
```

## The agent\_DataDogProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_DataDogProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_DataDogProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_DataDogProvisioningConfiguration":{"title":"DataDog connection configuration","type":"object","description":"Datadog event stream Channel"}}}}
```

## The agent\_SplunkProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SplunkProvisioningConfiguration":{"title":"Splunk connection configuration","required":["source"],"type":"object","properties":{"source":{"title":"Source","description":"Source to associate with generated Splunk events","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"Source to associate with generated Splunk events"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Splunk Audit Channel"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_SplunkProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_SplunkProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_SplunkProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_SplunkProvisioningConfiguration":{"title":"Splunk connection configuration","required":["source"],"type":"object","properties":{"source":{"title":"Source","description":"Source to associate with generated Splunk events","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"Source to associate with generated Splunk events"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Splunk Audit Channel"}}}}
```

## The agent\_LensesHQProvisioningConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LensesHQProvisioningConfiguration":{"title":"LensesHQServer connection configuration","required":["server","port","agentKey"],"type":"object","properties":{"server":{"title":"LensesHQ Server","description":"The address or hostname of the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Server","type":"string","description":"The address or hostname of the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"LensesHQ Port","description":"The port number used for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Port","type":"integer","description":"The port number used for communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"agentKey":{"title":"LensesHQ secret Key","description":"The secret key used for authentication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ secret Key","type":"string","description":"The secret key used for authentication with the LensesHQ server.","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxBackOffInterval":{"title":"LensesHQ Max BackOff Interval","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max BackOff Interval","type":"integer","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"isShutDownInterval":{"title":"LensesHQ ShutDown Interval","description":"The interval for shutting down the LensesHQ server gracefully.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ ShutDown Interval","type":"integer","description":"The interval for shutting down the LensesHQ server gracefully.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"connectTimeout":{"title":"LensesHQ Connection Timeout","description":"The timeout duration for establishing a connection with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Connection Timeout","type":"integer","description":"The timeout duration for establishing a connection with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxJitterWindowMilliseconds":{"title":"LensesHQ Max Jitter Window Milliseconds","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max Jitter Window Milliseconds","type":"integer","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabled":{"title":"LensesHQ SSL Enabled","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled","type":"boolean","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabledProtocols":{"title":"LensesHQ SSL Enabled Protocols","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled Protocols","type":"string","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"algorithm":{"title":"LensesHQ SSL algorithm","description":"The SSL algorithm to use when establishing the connection.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL algorithm","type":"string","description":"The SSL algorithm to use when establishing the connection."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"cipherSuites":{"title":"LensesHQ Cipher Suites","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Cipher Suites","type":"string","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"panoptes.sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"},"panoptes.sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"}},"description":"Connection to Lenses HQ instance"},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1}}}}
```

## The agent\_LensesHQProvisioningEntry object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_LensesHQProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_LensesHQProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_LensesHQProvisioningConfiguration":{"title":"LensesHQServer connection configuration","required":["server","port","agentKey"],"type":"object","properties":{"server":{"title":"LensesHQ Server","description":"The address or hostname of the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Server","type":"string","description":"The address or hostname of the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"LensesHQ Port","description":"The port number used for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Port","type":"integer","description":"The port number used for communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"agentKey":{"title":"LensesHQ secret Key","description":"The secret key used for authentication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ secret Key","type":"string","description":"The secret key used for authentication with the LensesHQ server.","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxBackOffInterval":{"title":"LensesHQ Max BackOff Interval","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max BackOff Interval","type":"integer","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"isShutDownInterval":{"title":"LensesHQ ShutDown Interval","description":"The interval for shutting down the LensesHQ server gracefully.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ ShutDown Interval","type":"integer","description":"The interval for shutting down the LensesHQ server gracefully.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"connectTimeout":{"title":"LensesHQ Connection Timeout","description":"The timeout duration for establishing a connection with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Connection Timeout","type":"integer","description":"The timeout duration for establishing a connection with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxJitterWindowMilliseconds":{"title":"LensesHQ Max Jitter Window Milliseconds","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max Jitter Window Milliseconds","type":"integer","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabled":{"title":"LensesHQ SSL Enabled","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled","type":"boolean","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabledProtocols":{"title":"LensesHQ SSL Enabled Protocols","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled Protocols","type":"string","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"algorithm":{"title":"LensesHQ SSL algorithm","description":"The SSL algorithm to use when establishing the connection.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL algorithm","type":"string","description":"The SSL algorithm to use when establishing the connection."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"cipherSuites":{"title":"LensesHQ Cipher Suites","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Cipher Suites","type":"string","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"panoptes.sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"},"panoptes.sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"}},"description":"Connection to Lenses HQ instance"}}}}
```

## The agent\_UpdateConnectionStateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Lenses API","version":"6.2"},"components":{"schemas":{"agent_UpdateConnectionStateRequest":{"title":"Provisioning manifest","type":"object","properties":{"kafka":{"type":"array","items":{"$ref":"#/components/schemas/agent_KafkaProvisioningEntry"}},"confluentSchemaRegistry":{"type":"array","items":{"$ref":"#/components/schemas/agent_ConfluentSchemaRegistryProvisioningEntry"}},"glueSchemaRegistry":{"type":"array","items":{"$ref":"#/components/schemas/agent_GlueSchemaRegistryProvisioningEntry"}},"connect":{"type":"array","items":{"$ref":"#/components/schemas/agent_KafkaConnectProvisioningEntry"}},"zookeeper":{"type":"array","items":{"$ref":"#/components/schemas/agent_ZookeeperProvisioningEntry"}},"kerberos":{"type":"array","items":{"$ref":"#/components/schemas/agent_KerberosProvisioningEntry"}},"aws":{"type":"array","items":{"$ref":"#/components/schemas/agent_AWSProvisioningEntry"}},"postgres":{"type":"array","items":{"$ref":"#/components/schemas/agent_PostgresProvisioningEntry"}},"alertManager":{"type":"array","items":{"$ref":"#/components/schemas/agent_AlertManagerProvisioningEntry"}},"webhook":{"type":"array","items":{"$ref":"#/components/schemas/agent_WebhookProvisioningEntry"}},"slack":{"type":"array","items":{"$ref":"#/components/schemas/agent_SlackProvisioningEntry"}},"pagerDuty":{"type":"array","items":{"$ref":"#/components/schemas/agent_PagerDutyProvisioningEntry"}},"datadog":{"type":"array","items":{"$ref":"#/components/schemas/agent_DataDogProvisioningEntry"}},"splunk":{"type":"array","items":{"$ref":"#/components/schemas/agent_SplunkProvisioningEntry"}},"lensesHq":{"type":"array","items":{"$ref":"#/components/schemas/agent_LensesHQProvisioningEntry"}}},"description":"YAML manifest describing the desired connection state of the agent. Top-level keys group connections by kind; each item describes a single connection. Properties may be supplied inline (`value`), as a reference to another connection (`reference`), or as a path to an attached file (`file`)."},"agent_KafkaProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KafkaProvisioningConfiguration"}}},"agent_ProvisioningReferenceable":{"type":"string","description":"An alphanumeric or dash non-empty string used as a connection name or reference.","pattern":"^[a-zA-Z0-9-]+$","minLength":1},"agent_KafkaProvisioningConfiguration":{"title":"Kafka connection configuration","required":["kafkaBootstrapServers"],"type":"object","properties":{"kafkaBootstrapServers":{"title":"Kafka Bootstrap Servers","description":"Comma separated list of protocol://host:port to use for initial connection to Kafka.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kafka Bootstrap Servers","type":"array","items":{"type":"string","minLength":1},"description":"Comma separated list of protocol://host:port to use for initial connection to Kafka."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"protocol":{"title":"Security protocol","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Security protocol","type":"string","description":"One of following values: PLAINTEXT, SSL, SASL_SSL, SASL_PLAINTEXT","enum":["PLAINTEXT","SSL","SASL_PLAINTEXT","SASL_SSL"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslMechanism":{"title":"SASL Mechanism","description":"Mechanism to use when authenticated using SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Mechanism","type":"string","description":"Mechanism to use when authenticated using SASL","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"saslJaasConfig":{"title":"SASL Jaas config","description":"JAAS Login module configuration for SASL","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SASL Jaas config","type":"string","description":"JAAS Login module configuration for SASL","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"keytab":{"title":"Keytab file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded contents of the keytab file"},"additionalProperties":{"title":"Additional properties for Kafka connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Kafka connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["AWS","JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: BrokerId -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: BrokerId -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"kafkaConnectivityTimeout":{"title":"Connectivity check timeout","description":"Timeout (ms) for the Test Connection connectivity check","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Connectivity check timeout","type":"integer","description":"Timeout (ms) for the Test Connection connectivity check","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Apache Kafka"},"agent_ConfluentSchemaRegistryProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_ConfluentSchemaRegistryProvisioningConfiguration"}}},"agent_ConfluentSchemaRegistryProvisioningConfiguration":{"title":"SchemaRegistry connection configuration","required":["schemaRegistryUrls"],"type":"object","properties":{"schemaRegistryUrls":{"title":"urls","description":"List of schema registry urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of schema registry urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"additionalProperties":{"title":"Additional properties for Schema Registry connection","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Additional properties for Schema Registry connection","type":"object","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"hardDelete":{"title":"Hard Delete","description":"Enables Schema Registry hard delete","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Hard Delete","type":"boolean","description":"Enables Schema Registry hard delete"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Schema registries"},"agent_GlueSchemaRegistryProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_GlueSchemaRegistryProvisioningConfiguration"}}},"agent_GlueSchemaRegistryProvisioningConfiguration":{"title":"AWSGlueSchemaRegistry connection configuration","required":["glueRegistryArn"],"type":"object","properties":{"glueRegistryArn":{"title":"ARN","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"ARN","type":"string","description":"Enter the Amazon Resource Name (ARN) of the Glue schema registry that you want to connect to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheTtl":{"title":"Cache time to live","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache time to live","type":"integer","description":"The period in milliseconds that Lenses will be updating its schema cache from AWS Glue.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryCacheSize":{"title":"Cache size","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Cache size","type":"integer","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"glueRegistryDefaultCompatibility":{"title":"Default compatibility mode to use on Schema creation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default compatibility mode to use on Schema creation","type":"string","enum":["BACKWARD","BACKWARD_ALL","FORWARD","FORWARD_ALL","FULL","FULL_ALL","NONE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS Glue Schema registry"},"agent_KafkaConnectProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KafkaConnectProvisioningConfiguration"}}},"agent_KafkaConnectProvisioningConfiguration":{"title":"KafkaConnect connection configuration","required":["workers"],"type":"object","properties":{"workers":{"title":"workers","description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used ","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"workers","type":"array","items":{"type":"string","minLength":1},"description":"A list of workers, with such a format: `HOST:PORT;METRICS_PORT`. METRICS_PORT is optional,if omitted - the default port (defined in separate `metrics.port` property) will be used "}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"aes256Key":{"title":"AES256 Key for Connector Secrets","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"AES256 Key for Connector Secrets","type":"string","description":"AES256 Key used to encrypt secret properties when deploying Connectors to this ConnectCluster","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"Username","description":"Username for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Username","type":"string","description":"Username for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"Password for HTTP Basic Authentication","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"Password for HTTP Basic Authentication","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl keystore file content"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"Base64 encoded ssl truststore file content"},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Kafka Connect cluster connection."},"agent_ZookeeperProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_ZookeeperProvisioningConfiguration"}}},"agent_ZookeeperProvisioningConfiguration":{"title":"Zookeeper connection configuration","required":["zookeeperUrls","zookeeperSessionTimeout","zookeeperConnectionTimeout"],"type":"object","properties":{"zookeeperUrls":{"title":"urls","description":"List of zookeeper urls","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"urls","type":"array","items":{"type":"string","minLength":1},"description":"List of zookeeper urls"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperChrootPath":{"title":"Zookeeper /znode path","description":"Zookeeper /znode path","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper /znode path","type":"string","description":"Zookeeper /znode path"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperSessionTimeout":{"title":"Zookeeper connection session timeout (ms)","description":"Zookeeper connection session timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection session timeout (ms)","type":"integer","description":"Zookeeper connection session timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"zookeeperConnectionTimeout":{"title":"Zookeeper connection timeout (ms)","description":"Zookeeper connection timeout","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Zookeeper connection timeout (ms)","type":"integer","description":"Zookeeper connection timeout"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsType":{"title":"Metrics type","description":"Metrics type","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics type","type":"string","description":"Metrics type","minLength":1,"enum":["JMX","JOLOKIAG","JOLOKIAP"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPort":{"title":"Default metrics port","description":"Default port number for metrics connection (JMX and JOLOKIA)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Default metrics port","type":"integer","description":"Default port number for metrics connection (JMX and JOLOKIA)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsUsername":{"title":"Metrics username","description":"The username for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics username","type":"string","description":"The username for metrics connections","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsPassword":{"title":"Metrics password","description":"The password for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics password","type":"string","description":"The password for metrics connections","format":"password","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsSsl":{"title":"SSL enabled","description":"Flag to enable SSL for metrics connections","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL enabled","type":"boolean","description":"Flag to enable SSL for metrics connections"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpSuffix":{"title":"Http url suffix","description":"Http url suffix","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Http url suffix","type":"string","description":"Http url suffix","minLength":1}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsHttpTimeout":{"title":"HTTP Request timeout","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"HTTP Request timeout (ms) for Jolokia or AWS metrics"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomUrlMappings":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> MetricsUrl","type":"object","description":"Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsCustomPortMappings":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","description":"DEPRECATED","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Metrics custom mapping: ServiceUrl -> JmxPort","type":"object","description":"DEPRECATED","additionalProperties":{"type":"string"}}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingMaxRetries":{"title":"HTTP Rate Limiting Max Retries","description":"HTTP retries when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Max Retries","type":"integer","description":"HTTP retries when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"metricsRateLimitingBackoff":{"title":"HTTP Rate Limiting Backoff Interval","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Rate Limiting Backoff Interval","type":"integer","description":"The backoff interval (ms) when 429 is returned for Jolokia metrics","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Zookeeper"},"agent_KerberosProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_KerberosProvisioningConfiguration"}}},"agent_KerberosProvisioningConfiguration":{"title":"Kerberos connection configuration","required":["kerberosKrb5"],"type":"object","properties":{"kerberosKrb5":{"title":"Kerberos krb5 config","description":"Kerberos krb5.conf file","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Kerberos krb5 config","type":"string","description":"Kerberos krb5.conf file"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to Kerberos server"},"agent_AWSProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_AWSProvisioningConfiguration"}}},"agent_AWSProvisioningConfiguration":{"title":"AWS connection configuration","required":["authMode"],"type":"object","properties":{"accessKeyId":{"title":"Access Key ID","description":"Access key ID of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Access Key ID","type":"string","description":"Access key ID of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"secretAccessKey":{"title":"Secret Access Key","description":"Secret access key of an AWS IAM account","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Secret Access Key","type":"string","description":"Secret access key of an AWS IAM account","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"region":{"title":"Region","description":"AWS region to connect to. If not provided, this is deferred to client configuration.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Region","type":"string","description":"AWS region to connect to. If not provided, this is deferred to client configuration."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sessionToken":{"title":"Session token","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Session token","type":"string","description":"Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"authMode":{"title":"Authentication mode","description":"Way to authenticate against AWS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Authentication mode","type":"string","description":"Way to authenticate against AWS","enum":["Access Key","Credentials Chain","Assume Role"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleArn":{"title":"Role ARN","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role ARN","type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"assumeRoleSessionName":{"title":"Role Session Name","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Role Session Name","type":"string","description":"An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Connection to AWS IAM account"},"agent_PostgresProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_PostgresProvisioningConfiguration"}}},"agent_PostgresProvisioningConfiguration":{"title":"PostgreSQL connection configuration","required":["host","port","database","username","sslMode"],"type":"object","properties":{"host":{"title":"Host","description":"The Postgres hostname","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Host","type":"string","description":"The Postgres hostname"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"Port","description":"The port number","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Port","type":"integer","description":"The port number","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"database":{"title":"Database name","description":"The database to connect to","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Database name","type":"string","description":"The database to connect to"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"username":{"title":"User name","description":"The user name","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"User name","type":"string","description":"The user name"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"password":{"title":"Password","description":"The password","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Password","type":"string","description":"The password","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslMode":{"title":"SSL Mode","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL Mode","type":"string","description":"The SSL connection mode as detailed in https://jdbc.postgresql.org/documentation/head/ssl-client.html","enum":["disable","allow","prefer","require","verify-ca","verify-full"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"PostgreSQL Connection"},"agent_AlertManagerProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_AlertManagerProvisioningConfiguration"}}},"agent_AlertManagerProvisioningConfiguration":{"title":"PrometheusAlertmanager connection configuration","required":["source","generator-url","ssl"],"type":"object","properties":{"source":{"title":"Source","description":"The Lenses instance raising the alert.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"The Lenses instance raising the alert."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"generator-url":{"title":"Generator URL","description":"A URL to identify the source.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Generator URL","type":"string","description":"A URL to identify the source."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"ssl":{"title":"SSL","description":"If true it enables SSL.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL","type":"boolean","description":"If true it enables SSL."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"publish-interval":{"title":"Publish Interval","description":"The interval in milliseconds to send the alerts raised to Alert manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Publish Interval","type":"integer","description":"The interval in milliseconds to send the alerts raised to Alert manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-connect-timeout":{"title":"HTTP Connection timeout","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Connection timeout","type":"integer","description":"Time in milliseconds which determines the timeout in milliseconds until a connection is established.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-request-timeout":{"title":"HTTP Request timeout","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Request timeout","type":"integer","description":"The timeout in milliseconds used when requesting a connection from the connection manager.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"http-socket-timeout":{"title":"HTTP socket timeout","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP socket timeout","type":"integer","description":"Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Prometheus Alert Manager Channel."},"agent_WebhookProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_WebhookProvisioningConfiguration"}}},"agent_WebhookProvisioningConfiguration":{"title":"Webhook connection configuration","required":["method","insecure"],"type":"object","properties":{"method":{"title":"HTTP method","description":"The HTTP method to use.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP method","type":"string","description":"The HTTP method to use.","enum":["POST","PUT","PATCH","GET","DELETE"]}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"path":{"title":"Request path","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Request path","type":"string","description":"A URI encoded request path, which may include a query string. Supports audit-variable interpolation."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"headers":{"title":"HTTP Headers","description":"A list of HTTP header strings. Supports audit-variable interpolation","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"HTTP Headers","type":"array","items":{"type":"string"},"description":"A list of HTTP header strings. Supports audit-variable interpolation"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"body":{"title":"Body payload","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Body payload","type":"string","description":"A list of HTTP POST parameters (supports audit-variable interpolation). Will require 'method' to be POST, PUT or PATCH and automatically set the `Content-Type` to `application/x-www-form-urlencoded`"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"insecure":{"title":"Disable SSL certificate verification","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Disable SSL certificate verification","type":"boolean","description":"If set, will disable SSL certificate verification. This is *not encouraged* unless you really have no other options."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Web Hook Channel"},"agent_SlackProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_SlackProvisioningConfiguration"}}},"agent_SlackProvisioningConfiguration":{"title":"Slack connection configuration","required":["username","channel"],"type":"object","properties":{"username":{"title":"Slack username","description":"The user name to appear in slack as the sender.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack username","type":"string","description":"The user name to appear in slack as the sender."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"channel":{"title":"Slack channel","description":"The Slack channel send alerts to.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Slack channel","type":"string","description":"The Slack channel send alerts to."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"icon-url":{"title":"Icon URL","description":"The full path to an image to set for the slack message.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Icon URL","type":"string","description":"The full path to an image to set for the slack message."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Slack Alert Channel"},"agent_PagerDutyProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_PagerDutyProvisioningConfiguration"}}},"agent_PagerDutyProvisioningConfiguration":{"title":"PagerDuty connection configuration","type":"object","description":"PagerDuty Alert Channel"},"agent_DataDogProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_DataDogProvisioningConfiguration"}}},"agent_DataDogProvisioningConfiguration":{"title":"DataDog connection configuration","type":"object","description":"Datadog event stream Channel"},"agent_SplunkProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_SplunkProvisioningConfiguration"}}},"agent_SplunkProvisioningConfiguration":{"title":"Splunk connection configuration","required":["source"],"type":"object","properties":{"source":{"title":"Source","description":"Source to associate with generated Splunk events","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"Source","type":"string","description":"Source to associate with generated Splunk events"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]}},"description":"Splunk Audit Channel"},"agent_LensesHQProvisioningEntry":{"required":["name","version","tags","configuration"],"type":"object","properties":{"name":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"},"version":{"type":"integer","description":"Manifest version of the connection state."},"tags":{"type":"array","items":{"type":"string"}},"editorTag":{"type":"string","description":"Optional metadata tag set by editor tooling."},"configuration":{"$ref":"#/components/schemas/agent_LensesHQProvisioningConfiguration"}}},"agent_LensesHQProvisioningConfiguration":{"title":"LensesHQServer connection configuration","required":["server","port","agentKey"],"type":"object","properties":{"server":{"title":"LensesHQ Server","description":"The address or hostname of the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Server","type":"string","description":"The address or hostname of the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"port":{"title":"LensesHQ Port","description":"The port number used for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Port","type":"integer","description":"The port number used for communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"agentKey":{"title":"LensesHQ secret Key","description":"The secret key used for authentication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ secret Key","type":"string","description":"The secret key used for authentication with the LensesHQ server.","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxBackOffInterval":{"title":"LensesHQ Max BackOff Interval","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max BackOff Interval","type":"integer","description":"The maximum interval for backoff retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"isShutDownInterval":{"title":"LensesHQ ShutDown Interval","description":"The interval for shutting down the LensesHQ server gracefully.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ ShutDown Interval","type":"integer","description":"The interval for shutting down the LensesHQ server gracefully.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"connectTimeout":{"title":"LensesHQ Connection Timeout","description":"The timeout duration for establishing a connection with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Connection Timeout","type":"integer","description":"The timeout duration for establishing a connection with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"maxJitterWindowMilliseconds":{"title":"LensesHQ Max Jitter Window Milliseconds","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Max Jitter Window Milliseconds","type":"integer","description":"The maximum duration of jitter window in milliseconds for retries in communication with the LensesHQ server.","format":"int64"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabled":{"title":"LensesHQ SSL Enabled","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled","type":"boolean","description":"Indicates whether SSL/TLS encryption is enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslEnabledProtocols":{"title":"LensesHQ SSL Enabled Protocols","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL Enabled Protocols","type":"string","description":"The list of SSL/TLS protocols enabled for communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"algorithm":{"title":"LensesHQ SSL algorithm","description":"The SSL algorithm to use when establishing the connection.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ SSL algorithm","type":"string","description":"The SSL algorithm to use when establishing the connection."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"cipherSuites":{"title":"LensesHQ Cipher Suites","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server.","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"LensesHQ Cipher Suites","type":"string","description":"The list of cipher suites supported for encryption in communication with the LensesHQ server."}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"panoptes.sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"panoptes.sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"},"panoptes.sslAlgorithm":{"title":"SSL algorithm","description":"Name of the ssl algorithm. If empty default one will be used (X509)","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL algorithm","type":"string","description":"Name of the ssl algorithm. If empty default one will be used (X509)"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeystore":{"title":"SSL keystore","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL keystore file"},"sslKeystorePassword":{"title":"SSL keystore password","description":"Password to the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL keystore password","type":"string","description":"Password to the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslKeyPassword":{"title":"SSL key password","description":"Key password for the keystore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL key password","type":"string","description":"Key password for the keystore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststorePassword":{"title":"SSL truststore password","description":"Password to the truststore","oneOf":[{"required":["value"],"type":"object","properties":{"value":{"title":"SSL truststore password","type":"string","description":"Password to the truststore","format":"password"}}},{"required":["file"],"type":"object","properties":{"file":{"type":"string"}}},{"required":["reference"],"type":"object","properties":{"reference":{"$ref":"#/components/schemas/agent_ProvisioningReferenceable"}}}]},"sslTruststore":{"title":"SSL truststore file","required":["file"],"type":"object","properties":{"file":{"type":"string"}},"description":"SSL truststore file"}},"description":"Connection to Lenses HQ instance"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.lenses.io/latest/api-reference/reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.