{ "openapi": "3.0.0", "info": { "title": "Lenses API", "version": "6.1" }, "servers": [ { "url": "{server}", "variables": { "server": { "default": "https://api.example.com" } } } ], "tags": [ { "name": "hq_environments", "x-displayName": "Environments", "description": "Manage Lenses environments and configurations" }, { "name": "hq_login", "x-displayName": "Login", "description": "Password-based login" }, { "name": "hq_users", "x-displayName": "Users", "description": "User account management" }, { "name": "hq_service-accounts", "x-displayName": "Service Accounts", "description": "Service account management and authentication" }, { "name": "hq_groups", "x-displayName": "Groups", "description": "User group management" }, { "name": "hq_roles", "x-displayName": "Roles", "description": "Role-based access control management" }, { "name": "hq_permissions", "x-displayName": "Permissions", "description": "Permission management and access control" }, { "name": "hq_settings", "x-displayName": "Settings", "description": "System settings and configuration" }, { "name": "hq_licence", "x-displayName": "Licence", "description": "License information and management" }, { "name": "hq_meta", "x-displayName": "Meta", "description": "System metadata and information" }, { "name": "hq_k2kapps", "x-displayName": "K2K Apps", "description": "Kafka 2 Kafka application management" }, { "name": "agent_Datasets", "x-displayName": "Datasets" }, { "name": "agent_Kafka", "x-displayName": "Kafka" }, { "name": "agent_SchemaRegistry", "x-displayName": "Schema Registry" }, { "name": "agent_Approvals", "x-displayName": "Approvals" }, { "name": "agent_DataPolicies", "x-displayName": "Data Policies" }, { "name": "agent_Deployments", "x-displayName": "Deployments" }, { "name": "agent_ApplicationsManagement", "x-displayName": "Applications Management" }, { "name": "agent_SqlStreaming", "x-displayName": "SQL Streaming" }, { "name": "agent_SqlSnapshot", "x-displayName": "SQL Snapshot" }, { "name": "agent_Alerts", "x-displayName": "Alerts" }, { "name": "agent_Audits", "x-displayName": "Audits" }, { "name": "agent_Connections", "description": "APIs for managing connections to external systems.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections" }, { "name": "agent_KafkaConnections", "description": "APIs for managing connections that use the `Kafka` template.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > Kafka" }, { "name": "agent_ConfluentSchemaRegistryConnections", "description": "APIs for managing connections that use the `SchemaRegistry` template.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > Schema Registry" }, { "name": "agent_AWSGlueSchemaRegistryConnections", "description": "APIs for managing connections that use the `AWSGlueSchemaRegistry` template.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > AWS Glue Schema Registry" }, { "name": "agent_KafkaConnectConnections", "description": "APIs for managing connections that use the `KafkaConnect` template.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > Kafka Connect" }, { "name": "agent_ZookeeperConnections", "description": "APIs for managing connections that use the `Zookeeper` template.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > Zookeeper" }, { "name": "agent_KerberosConnections", "description": "APIs for managing connections that use the `Kerberos` template.\n\n DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.\n", "x-displayName": "Connections > Kerberos" }, { "name": "agent_ProvisioningState", "x-displayName": "Provisioning State" }, { "name": "agent_Metadata", "x-displayName": "Metadata" }, { "name": "agent_BackupRestore", "x-displayName": "Backup & Restore" }, { "name": "agent_AsCode", "x-displayName": "As Code" }, { "name": "agent_Kafka Connect", "x-displayName": "Kafka Connect" } ], "paths": { "/api/v1/environments": { "get": { "description": "Lists all environments", "operationId": "listEnvironments", "x-lenses-rbac": { "action": "environments:ListEnvironments", "alwaysAllow": true, "customPostProcess": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_EnvironmentList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new environment.", "operationId": "createEnvironment", "x-lenses-no-cache": true, "x-lenses-rbac": { "action": "environments:CreateEnvironment", "resource": { "Environment": { "request": "name" } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CreateEnvironmentRequest" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_NewEnvironmentWithKey" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{name}": { "get": { "description": "Retrieves a single environment by name.", "operationId": "getEnvironment", "x-lenses-rbac": { "action": "environments:GetEnvironmentDetails", "resource": { "Environment": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Environment" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates an environment.", "operationId": "updateEnvironment", "x-lenses-rbac": { "action": "environments:UpdateEnvironment", "resource": { "Environment": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateEnvironmentRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Environment" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes an environment.", "operationId": "deleteEnvironment", "x-lenses-rbac": { "action": "environments:DeleteEnvironment", "resource": { "Environment": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{env_name}/kafka-connections": { "get": { "description": "Lists Kafka connections defined for an Environment.", "operationId": "listKafkaConnections", "x-lenses-rbac": { "action": "environments:ListKafkaConnections", "alwaysAllow": true, "customPostProcess": true }, "parameters": [ { "in": "path", "name": "env_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_KafkaConnectionList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{env_name}/kafka-connections/{conn_name}": { "get": { "description": "Retrieves a Kafka connection defined for an Environment.", "operationId": "getKafkaConnection", "x-lenses-rbac": { "action": "environments:GetKafkaConnectionDetails", "resource": { "Environment": { "path": "env_name" }, "Connection": { "path": "conn_name" } } }, "parameters": [ { "in": "path", "name": "env_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "conn_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_KafkaConnection" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "description": "Upserts a particular Environment's Kafka connection.", "operationId": "upsertKafkaConnection", "x-lenses-rbac": { "action": "environments:UpsertKafkaConnection", "resource": { "Environment": { "path": "env_name" }, "Connection": { "path": "conn_name" } } }, "parameters": [ { "in": "path", "name": "env_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "conn_name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpsertKafkaConnectionRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_KafkaConnection" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a particular Environment's Kafka connection.", "operationId": "deleteKafkaConnection", "x-lenses-rbac": { "action": "environments:DeleteKafkaConnection", "resource": { "Environment": { "path": "env_name" }, "Connection": { "path": "conn_name" } } }, "parameters": [ { "in": "path", "name": "env_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "conn_name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Succesful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{name}/renew-key": { "post": { "description": "Generates a new agent key and invalidates the old.", "operationId": "renewEnvironmentKey", "x-lenses-no-cache": true, "x-lenses-rbac": { "action": "environments:UpdateEnvironment", "resource": { "Environment": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_NewEnvironmentWithKey" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/live/sse": { "get": { "description": "Provides Server-Sent Events (SSE) for environment updates. TODO.", "operationId": "observeEnvironmentUpdates", "x-lenses-rbac": { "action": "environments:ListEnvironments", "alwaysAllow": true }, "responses": { "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "x-lenses-vanilla-http-handler": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v2/environments/live/sse": { "get": { "description": "Server-Sent Events (SSE) stream of environment list changes. Wire format follows MDN SSE with\nnamed events: the JSON payload is carried in the data field and the event name is written in a\npreceding event field. Auth is applied per-item before emission. The server emits the following\nnamed events: initial (full current list, EnvironmentLiveItemsPayload), upsert (only changed or\ncreated environments, EnvironmentLiveItemsPayload), and delete (only deleted environment IDs,\nEnvironmentLiveDeletePayload).\n", "operationId": "observeEnvironmentUpdatesV2", "x-lenses-rbac": { "action": "environments:ListEnvironments", "alwaysAllow": true }, "responses": { "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "x-lenses-vanilla-http-handler": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{name}/proxy/": { "get": { "description": "Proxies HTTP to a Lenses instance. Note: this is not a regular HTTP API\nendpoint. The path specified here is a prefix. Everything beneath it\ngets proxied to the corresponding Lenses instance. Any request body and\nmethod (the GET here is only a placeholder) are accepted, as long as the\nLenses API accepts it. The connection can even be upgraded to a\nwebsocket. The status code and response body are controlled by the\nLenses API. This concept does not fit into the OpenAPI world at all;\nthis definition is only here for the sake of documentation to avoid\nhaving an undocumented dark matter API.\n", "operationId": "proxyToLensesAPI", "x-lenses-rbac": { "action": "environments:AccessEnvironment", "resource": { "Environment": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_environments" ], "x-lenses-path-prefix": true, "x-lenses-any-method": true, "x-lenses-vanilla-http-handler": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/groups": { "get": { "description": "Lists all groups", "operationId": "listGroups", "x-lenses-rbac": { "action": "iam:ListGroups", "alwaysAllow": true, "customPostProcess": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CompactGroupList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_groups" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new Group.", "operationId": "createGroup", "x-lenses-rbac": { "action": "iam:CreateGroup", "resource": { "Group": { "request": "name" } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CreateGroupRequest" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Group" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_groups" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/groups/{name}": { "get": { "description": "Gets a group by its name.", "operationId": "getGroup", "x-lenses-rbac": { "action": "iam:GetGroupDetails", "resource": { "Group": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Group" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_groups" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates a group.", "operationId": "updateGroup", "x-lenses-rbac": { "action": "iam:UpdateGroup", "resource": { "Group": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateGroupRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Group" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_groups" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a group.", "operationId": "deleteGroup", "x-lenses-rbac": { "action": "iam:DeleteGroup", "resource": { "Group": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_groups" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users": { "get": { "description": "Returns all users", "operationId": "listUsers", "x-lenses-rbac": { "action": "iam:ListUsers", "alwaysAllow": true, "customPostProcess": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UserList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new user.", "operationId": "createUser", "x-lenses-rbac": { "action": "iam:CreateUser", "resource": { "Username": { "request": "name" } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CreateUserRequest" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_User" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users/{name}": { "get": { "description": "Returns a specific user", "operationId": "getUser", "x-lenses-rbac": { "action": "iam:GetUserDetails", "resource": { "Username": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_User" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates a user.", "operationId": "updateUser", "x-lenses-rbac": { "action": "iam:UpdateUser", "resource": { "Username": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateUserRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_User" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a user.", "operationId": "deleteUser", "x-lenses-rbac": { "action": "iam:DeleteUser", "resource": { "Username": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users/{name}/profile": { "patch": { "description": "Allows updating fields of the user profile.", "operationId": "updateUserProfile", "x-lenses-rbac": { "action": "iam:UpdateUser", "customPrecondition": true }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateUserProfileRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_User" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users/{name}/groups": { "put": { "description": "Assigns the given user exactly to the provided groups, ensuring they are not part of any other groups.", "operationId": "setUserGroupMemberships", "x-lenses-rbac": { "customPrecondition": true }, "parameters": [ { "in": "path", "name": "name", "required": true, "description": "The name of the user.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_SetGroupMembershipsRequest" } } } }, "responses": { "200": { "description": "User groups membership updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_User" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users/me": { "get": { "description": "Returns the currently authenticated user", "operationId": "getCurrentUser", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UserOrServiceAccount" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/users/me/settings": { "get": { "description": "Returns the current user's settings.", "operationId": "getCurrentUserSettings", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UserSettings" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Allows updating fields of the current user's settings.", "operationId": "updateCurrentUserSettings", "x-lenses-rbac": { "alwaysAllow": true }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateUserSettingsRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UserSettings" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/login": { "post": { "description": "Starts a session given a username/password and puts it into a cookie.", "operationId": "login", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_LoginRequest" } } } }, "responses": { "204": { "description": "Happy response. A set-cookie header will be present." } }, "tags": [ "hq_login" ] } }, "/api/v1/users/me/sessions": { "delete": { "description": "Deletes all sessions associated with the current user.", "operationId": "logout", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "204": { "description": "Happy response." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_users" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/service-accounts": { "get": { "description": "Returns all ServiceAccounts.", "operationId": "listServiceAccounts", "x-lenses-rbac": { "action": "iam:ListServiceAccounts", "alwaysAllow": true, "customPostProcess": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccountList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new ServiceAccount.", "operationId": "createServiceAccount", "x-lenses-no-cache": true, "x-lenses-rbac": { "action": "iam:CreateServiceAccount", "resource": { "ServiceAccount": { "request": "name" } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CreateServiceAccountRequest" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccountWithSecretToken" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/service-accounts/{name}": { "get": { "description": "Returns a specific ServiceAccount.", "operationId": "getServiceAccount", "x-lenses-rbac": { "action": "iam:GetServiceAccountDetails", "resource": { "ServiceAccount": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccount" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates a service account.", "operationId": "updateServiceAccount", "x-lenses-rbac": { "action": "iam:UpdateServiceAccount", "resource": { "ServiceAccount": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateServiceAccountRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccount" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a ServiceAccount.", "operationId": "deleteServiceAccount", "x-lenses-rbac": { "action": "iam:DeleteServiceAccount", "resource": { "ServiceAccount": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/service-accounts/{name}/renew-token": { "post": { "description": "Renews the service account's token. The current token is invalidated and a new one is generated. An optional expiration timestamp can be provided.", "operationId": "renewServiceAccountToken", "x-lenses-no-cache": true, "x-lenses-rbac": { "action": "iam:UpdateServiceAccount", "resource": { "ServiceAccount": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_RenewServiceAccountTokenRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccountWithSecretToken" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/service-accounts/{name}/groups": { "put": { "description": "Assigns the given service account exactly to the provided groups, ensuring they are not part of any other groups.", "operationId": "setServiceAccountGroupMemberships", "x-lenses-rbac": { "customPrecondition": true }, "parameters": [ { "in": "path", "name": "name", "required": true, "description": "The name of the service account.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_SetGroupMembershipsRequest" } } } }, "responses": { "200": { "description": "Service account groups membership updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_ServiceAccount" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_service-accounts" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/roles": { "get": { "description": "Returns all roles.", "operationId": "listRoles", "x-lenses-rbac": { "action": "iam:ListRoles", "alwaysAllow": true, "customPostProcess": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CompactRoleList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new role.", "operationId": "createRole", "x-lenses-rbac": { "action": "iam:CreateRole", "resource": { "Role": { "request": "name" } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_CreateRoleRequest" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Role" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/roles/{name}/policy": { "post": { "description": "Adds a permission statement to an existing Role's policy. No deduplication is done.", "operationId": "addPermissionStatementToRole", "x-lenses-rbac": { "action": "iam:UpdateRole", "resource": { "Role": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_PermissionStatement" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Role" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/roles/{name}": { "get": { "description": "Returns a specific role.", "operationId": "getRole", "x-lenses-rbac": { "action": "iam:GetRoleDetails", "resource": { "Role": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Role" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates a role.", "operationId": "updateRole", "x-lenses-rbac": { "action": "iam:UpdateRole", "resource": { "Role": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_UpdateRoleRequest" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Role" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a role.", "operationId": "deleteRole", "x-lenses-rbac": { "action": "iam:DeleteRole", "resource": { "Role": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful deletion." }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_roles" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/meta-info": { "get": { "description": "Returns the backend's meta information.", "operationId": "getRuntimeInfo", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_RuntimeInfo" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_meta" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/settings": { "get": { "description": "Returns the backend's settings information.", "operationId": "getSettings", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Successfully returns application settings response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Settings" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_settings" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/licence": { "get": { "description": "Returns HQ's licence.", "operationId": "getLicence", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Successfully returns licence response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Licence" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_licence" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/licence-summary": { "get": { "description": "Returns HQ's licence summary.", "operationId": "getLicenceSummary", "x-lenses-unauthenticated": true, "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Successfully returns licence response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_LicenceSummary" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_licence" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/permissions/definitions": { "get": { "description": "Returns (static) resource definitions of HQ's permission model.", "operationId": "getPermissionDefinitions", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_PermissionDefinitions" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_permissions" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v0/apps/k2k/{name}": { "get": { "description": "Retrieves a single K2KApp by name.", "operationId": "getK2KAppV0", "x-lenses-rbac": { "action": "k2k:GetApp", "resource": { "Name": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand_metrics", "required": false, "description": "Includes metrics in the response, if available.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithOptionalMetrics" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "description": "Creates a new K2KApp or updates an existing one.", "operationId": "applyK2KAppV0", "x-lenses-rbac": { "action": "k2k:UpsertApp", "customPrecondition": true }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/yaml": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KApp" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "description": "Updates an existing K2KApp.", "operationId": "updateK2KAppV0", "x-lenses-rbac": { "action": "k2k:UpdateApp", "customPrecondition": true }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/yaml": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } } } }, "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KApp" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "description": "Deletes a single K2KApp by name.", "operationId": "deleteK2KAppV0", "x-lenses-rbac": { "action": "k2k:DeleteApp", "resource": { "Name": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "required": false, "description": "Deletes the K2KApp instantly and skips waiting for deletion of any corresponding K8s resources.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KApp" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v0/apps/k2k": { "get": { "description": "Lists all K2KApps.", "operationId": "listK2KAppsV0", "x-lenses-rbac": { "alwaysAllow": true, "customPostProcess": true }, "parameters": [ { "in": "query", "name": "expand_metrics_summary", "required": false, "description": "Includes metrics summaries in the response, if available.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithOptionalMetricsSummaryList" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "description": "Creates a new K2KApp.", "operationId": "createK2KAppV0", "x-lenses-rbac": { "action": "k2k:CreateApp", "customPrecondition": true }, "requestBody": { "required": true, "content": { "application/yaml": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KAppWithoutStatus" } } } }, "responses": { "201": { "description": "Happy response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KApp" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v0/apps/k2k/{name}/position/offsets": { "put": { "tags": [ "hq_k2kapps" ], "summary": "Update Consumer Group Offsets for multiple partitions", "description": "Update the committed offsets for multiple topic partitions for a given K2K application.", "operationId": "updateK2KAppOffsetsByPosition", "x-lenses-rbac": { "action": "k2k:ManageOffsets", "resource": { "Name": { "path": "name" } } }, "parameters": [ { "in": "path", "name": "name", "description": "The unique name for the K2K application.", "required": true, "schema": { "type": "string" }, "example": "my-app-prod" } ], "requestBody": { "description": "A list of topic-partition-offset tuples to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KUpdateOffsetsRequest" } } } }, "responses": { "200": { "description": "Offsets successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KUpdateOffsetsResponse" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v0/apps/k2k/{name}/position/timestamp": { "put": { "tags": [ "hq_k2kapps" ], "summary": "Update Consumer Group Offsets based on timestamp", "description": "Update the committed offsets for multiple topics based on a timestamp. The offsets will be set to the earliest offset whose timestamp is greater than or equal to the given timestamp.", "operationId": "updateK2KAppOffsetsByTimestamp", "x-lenses-rbac": { "alwaysAllow": true }, "parameters": [ { "in": "path", "name": "name", "description": "The unique name for the K2K application.", "required": true, "schema": { "type": "string" }, "example": "my-app-prod" } ], "requestBody": { "description": "The timestamp and list of topics to update offsets for.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KUpdateOffsetsByTimestampRequest" } } } }, "responses": { "200": { "description": "Offsets successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_K2KUpdateOffsetsResponse" } } } }, "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/apps/k2k/live/sse": { "get": { "description": "Provides Server-Sent Events (SSE) for K2KApp updates. TODO.", "operationId": "observeK2KAppUpdates", "x-lenses-rbac": { "alwaysAllow": true }, "responses": { "default": { "description": "Error object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hq_Error" } } } } }, "tags": [ "hq_k2kapps" ], "x-lenses-vanilla-http-handler": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates": { "get": { "tags": [ "agent_Connections" ], "summary": "List connection templates", "description": "Lists all connections templates. \n\nA connection's template defines the type of the connection, and the schema of it's\nconfiguration.\n (DEPRECATED: Use provisioning instead)", "operationId": "listConnectionTemplates", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Filter by template kind", "required": false, "schema": { "$ref": "#/components/schemas/agent_TemplateType" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionTemplateResponse" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connections": { "post": { "tags": [ "agent_Connections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionApiRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connections/test": { "post": { "tags": [ "agent_Connections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TestConnectionApiRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connections/{name}": { "get": { "tags": [ "agent_Connections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ConnectionJsonResponseV2WithLrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Connections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_UpsertConnectionApiRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connections/{name}": { "delete": { "tags": [ "agent_Connections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections": { "get": { "tags": [ "agent_KafkaConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listKafkaConnectionsAgent", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_KafkaConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createKafkaConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections": { "post": { "tags": [ "agent_KafkaConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createKafkaConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/test": { "post": { "tags": [ "agent_KafkaConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testKafkaConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections/test": { "post": { "tags": [ "agent_KafkaConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testKafkaConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kafka/connections/{name}": { "get": { "tags": [ "agent_KafkaConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getKafkaConnectionAgent", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_KafkaConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateKafkaConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_KafkaConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteKafkaConnectionAgent", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kafka/connections/{name}": { "put": { "tags": [ "agent_KafkaConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateKafkaConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/SchemaRegistry/connections": { "get": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listSchemaRegistryConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/SchemaRegistry/connections": { "post": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createSchemaRegistryConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/SchemaRegistry/connections/test": { "post": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/SchemaRegistry/connections/test": { "post": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testSchemaRegistryConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/SchemaRegistry/connections/{name}": { "get": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateSchemaRegistryConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/SchemaRegistry/connections/{name}": { "put": { "tags": [ "agent_ConfluentSchemaRegistryConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateSchemaRegistryConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections": { "get": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listAWSGlueSchemaRegistryConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createAWSGlueSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections": { "post": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createAWSGlueSchemaRegistryConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/test": { "post": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testAWSGlueSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/test": { "post": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testAWSGlueSchemaRegistryConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}": { "get": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getAWSGlueSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateAWSGlueSchemaRegistryConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteAWSGlueSchemaRegistryConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}": { "put": { "tags": [ "agent_AWSGlueSchemaRegistryConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateAWSGlueSchemaRegistryConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections": { "get": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listKafkaConnectConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createKafkaConnectConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections": { "post": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createKafkaConnectConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/test": { "post": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testKafkaConnectConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections/test": { "post": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testKafkaConnectConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/{name}": { "get": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getKafkaConnectConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateKafkaConnectConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteKafkaConnectConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections/{name}": { "put": { "tags": [ "agent_KafkaConnectConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateKafkaConnectConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections": { "get": { "tags": [ "agent_ZookeeperConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listZookeeperConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createZookeeperConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections": { "post": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createZookeeperConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/test": { "post": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testZookeeperConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections/test": { "post": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testZookeeperConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Zookeeper/connections/{name}": { "get": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getZookeeperConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateZookeeperConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteZookeeperConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Zookeeper/connections/{name}": { "put": { "tags": [ "agent_ZookeeperConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateZookeeperConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ZookeeperConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kerberos/connections": { "get": { "tags": [ "agent_KerberosConnections" ], "summary": "List available connections", "description": "Returns the list of available connections", "operationId": "listKerberosConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionSummaryResponseWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_KerberosConnections" ], "summary": "Add a new connection", "description": "Adds a new connection", "operationId": "createKerberosConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionAddRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kerberos/connections": { "post": { "tags": [ "agent_KerberosConnections" ], "summary": "Add a new connection V2", "description": "Adds a new connection V2", "operationId": "createKerberosConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionAddRequestV2" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kerberos/connections/test": { "post": { "tags": [ "agent_KerberosConnections" ], "summary": "Validate a connection", "description": "Validates the connection", "operationId": "testKerberosConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionTestRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kerberos/connections/test": { "post": { "tags": [ "agent_KerberosConnections" ], "summary": "Validate a connection V2", "description": "Validates the connection V2", "operationId": "testKerberosConnectionV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionTestRequestV2" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/Kerberos/connections/{name}": { "get": { "tags": [ "agent_KerberosConnections" ], "summary": "Get connection details", "description": "Returns the connection details", "operationId": "getKerberosConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_KerberosConnections" ], "summary": "Update connection details", "description": "Updates the connection details", "operationId": "updateKerberosConnectionAgent1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionUpsertRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_KerberosConnections" ], "summary": "Delete a connection", "description": "Deletes the connection", "operationId": "deleteKerberosConnection", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/Kerberos/connections/{name}": { "put": { "tags": [ "agent_KerberosConnections" ], "summary": "Update connection details V2", "description": "Updates the connection details V2", "operationId": "updateKerberosConnection V2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "The name of the connection", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_KerberosConnectionUpsertRequestV2" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AddConnectionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/events": { "get": { "tags": [ "agent_Alerts" ], "summary": "List alert events", "description": "Returns alert events divided into pages. Allows to specify page number and page size.", "operationId": "listAlertEvents", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "summary", "in": "query", "description": "Allows to filter results by partial summary text", "required": false, "schema": { "type": "string" }, "example": "active controllers" }, { "name": "category", "in": "query", "description": "Allows to filter results by category. Accepted values are: 'Infrastructure', 'Consumers', 'Kafka Connect', 'Topics' )", "required": false, "schema": { "type": "string" }, "example": "Infrastructure" }, { "name": "level", "in": "query", "description": "Allows to filter results by level", "required": false, "schema": { "type": "string" }, "example": "INFO" }, { "name": "alertId", "in": "query", "description": "Allows to filter results by alert id", "required": false, "schema": { "type": "integer" }, "example": 1000 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Page_HttpAlert" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions/{condition_id}": { "get": { "tags": [ "agent_Alerts" ], "summary": "Get alert condition details", "operationId": "getAlertCondition", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 5000 }, { "name": "condition_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ConditionDetails" }, "example": { "createdAt": "2021-01-01T00:00:00Z", "createdBy": "john-doe", "modifiedAt": "2021-01-01T00:00:00Z", "modifiedBy": "joe-bloggs", "channels": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "slow-consumers-alerts", "templateName": "Webhook" } ], "condition": "", "conditionDsl": { "connectionName": "kafka", "datasetName": "positions", "threshold": { "type": "more_than", "messages": 100 }, "duration": "end_of_each_day" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Alerts" ], "summary": "Update alert condition", "operationId": "updateAlertCondition", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "description": "The Alert ID to enable", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 2000 }, { "name": "condition_id", "in": "path", "description": "The condition unique identifier", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "8ce90f4a-514b-45fc-a12e-268bc69525f5" } ], "requestBody": { "description": "The custom alert condition and a list of channel ids to route alerts to", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertConditionRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Alerts" ], "summary": "Delete alert condition", "operationId": "deleteAlertCondition", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "description": "The Alert ID to enable", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 2000 }, { "name": "condition_id", "in": "path", "description": "The condition unique identifier", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "8ce90f4a-514b-45fc-a12e-268bc69525f5" } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/alert/settings": { "get": { "tags": [ "agent_Alerts" ], "summary": "Get alert settings", "operationId": "getAlertSettingsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpCategorisedAlertRules" }, "example": { "categories": { "Kafka Connect": [], "Infrastructure": [ { "id": 1000, "description": "Kafka Broker is down", "category": "Infrastructure", "enabled": true, "isAvailable": true, "details": { "alertType": "Fixed", "channels": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "PagerDuty-incidents-prd", "templateName": "Pagerduty" } ], "conditionDsl": { "enabled": true, "restarts": 3, "gracePeriod": 120 }, "modifiedBy": "user", "modifiedAt": "2023-04-20T09:00:00Z" }, "lrn": "alerts:rule:my-dev/Infrastructure/1000" } ], "Topics": [], "Consumers": [ { "id": 2000, "description": "Consumer Lag exceeded", "category": "Consumers", "enabled": true, "conditionTemplate": "lag >= $Threshold-Number on group $Consumer-Group and topic $Topic-Name", "conditionRegex": "lag >= ([1-9][0-9]*) on group (\\b\\S+\\b) and topic (\\b\\S+\\b)", "docs": "Raises an alert when the consumer lag exceeds the threshold on any partition.", "isAvailable": true, "details": { "conditions": { "94d78565-db0b-4683-8d7d-6a0e6b8f2292": { "createdAt": "2021-01-01T00:00:00Z", "createdBy": "john-doe", "modifiedAt": "2021-01-01T00:00:00Z", "modifiedBy": "joe-bloggs", "channels": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "slow-consumers-alerts", "templateName": "Webhook" } ], "condition": "lag >= 4000 on group group and topic positions", "conditionDsl": { "group": "group", "topic": "positions", "threshold": 4000, "mode": "PerPartitionMode" } } }, "alertType": "Conditional" }, "lrn": "alerts:rule:my-dev/Consumers/2000" } ], "Data Produced": [ { "id": 5000, "description": "Data Produced", "category": "Data Produced", "enabled": true, "docs": "Raises an alert when the data produced on a topic doesn't match expected threshold", "isAvailable": true, "details": { "conditions": { "8ce90f4a-514b-45fc-a12e-268bc69525f5": { "createdAt": "2021-01-01T00:00:00Z", "createdBy": "john-doe", "modifiedAt": "2021-01-01T00:00:00Z", "modifiedBy": "joe-bloggs", "channels": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "data-produced-alarm", "templateName": "Webhook" } ], "condition": "", "conditionDsl": { "connectionName": "kafka", "datasetName": "positions", "threshold": { "type": "more_than", "messages": 4000 }, "duration": "PT15M" }, "conditionState": { "messagesProduced": 100, "lastCheck": "2021-01-01T00:00:00Z" } } }, "alertType": "Conditional" }, "lrn": "alerts:rule:my-dev/Data Produced/5000" } ], "Apps": [ { "id": 1000, "description": "Kafka Broker is down", "category": "Infrastructure", "enabled": true, "isAvailable": true, "details": { "alertType": "Fixed", "channels": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "PagerDuty-incidents-prd", "templateName": "Pagerduty" } ], "conditionDsl": { "enabled": true, "restarts": 3, "gracePeriod": 120 }, "modifiedBy": "user", "modifiedAt": "2023-04-20T09:00:00Z" }, "lrn": "alerts:rule:my-dev/Infrastructure/1000" } ] } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/alert/settings/{alert_setting_id}": { "put": { "tags": [ "agent_Alerts" ], "summary": "Update alert settings", "description": "update of a fixed alert setting", "operationId": "setAlertSettingsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "description": "The Alert ID to enable", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 1000 } ], "requestBody": { "description": "An request payload specifying whether to enable/disable the alert and supplying a distinct list of associated channel ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertSettingPutRequest" }, "example": { "enabled": true, "channels": [ "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" ], "config": { "enabled": true, "restarts": 5, "gracePeriod": 60 } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertSettingResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "tags": [ "agent_Alerts" ], "summary": "Partially update alert settings", "description": "partial update of a fixed alert setting", "operationId": "patchAlertSettingsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "description": "The Alert ID to enable", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 1000 } ], "requestBody": { "description": "An request payload specifying whether to enable/disable the alert and supplying a distinct list of associated channel ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertSettingPatchRequest" }, "example": { "enabled": true, "channels": [ "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" ], "config": { "enabled": true, "restarts": 3, "gracePeriod": 120 } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertSettingResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions": { "post": { "tags": [ "agent_Alerts" ], "summary": "Create alert condition", "operationId": "createAlertCondition", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alert_setting_id", "in": "path", "description": "The Alert ID to enable", "required": true, "schema": { "$ref": "#/components/schemas/agent_AlertSetting" }, "example": 2000 } ], "requestBody": { "description": "The custom alert condition and a list of channel ids to route alerts to", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertConditionRequest" }, "example": { "condition": { "group": "group1", "topic": "__topology", "threshold": 4000, "mode": "PerPartitionMode" }, "channels": [ "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AlertConditionResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/channels": { "get": { "tags": [ "agent_Alerts" ], "summary": "List alert channels", "description": "Lists alert channels ordered by their creation time (most recent first)", "operationId": "listAlertChannels", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "templateName", "in": "query", "description": "Filter by channel template name", "required": false, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "Matches channels by name", "required": false, "schema": { "type": "string" } }, { "name": "sortField", "in": "query", "description": "The field to sort results by", "required": false, "schema": { "$ref": "#/components/schemas/agent_ChannelField" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order. Defaults to ascending", "required": false, "schema": { "$ref": "#/components/schemas/agent_Order" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Page_HttpChannelEntity" }, "example": { "values": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "kafka-prd-health", "templateName": "Slack", "templateVersion": 1, "connectionName": "slack-connection", "properties": [ { "key": "channel", "value": "#my-kafka-health-prd" } ], "createdAt": "2021-01-01T00:00:00Z", "createdBy": "joe.bloggs", "updatedAt": "2021-01-01T00:00:00Z", "updatedBy": "joe.bloggs", "enabled": true, "lrn": "lrn" } ], "pagesAmount": 1, "totalCount": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_Alerts" ], "summary": "Create alert channel", "description": "The JSON object representing the properties to set this channel with", "operationId": "createAlertChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewChannelApiEntity" }, "example": { "name": "kafka-prd-health", "templateName": "Slack", "connectionName": "slack-connection", "properties": [ { "key": "channel", "value": "#my-kafka-health-prd" } ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewChannelResponse" }, "example": { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/channels/{id}": { "get": { "tags": [ "agent_Alerts" ], "summary": "Get alert channel details", "description": "Get the alert channel details", "operationId": "getAlertChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpChannelEntity" }, "example": { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "kafka-prd-health", "templateName": "Slack", "templateVersion": 1, "connectionName": "slack-connection", "properties": [ { "key": "channel", "value": "#my-kafka-health-prd" } ], "createdAt": "2021-01-01T00:00:00Z", "createdBy": "joe.bloggs", "updatedAt": "2021-01-01T00:00:00Z", "updatedBy": "joe.bloggs", "enabled": true, "lrn": "lrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Alerts" ], "summary": "Update alert channel", "description": "Update alert channel", "operationId": "updateAlertChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "requestBody": { "description": "The JSON object representing the properties to set this channel with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_UpdateChannelApiEntity" }, "example": { "name": "kafka-prd-health", "connectionName": "slack-connection", "properties": [ { "key": "channel", "value": "#my-kafka-health-prd" } ] } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Alerts" ], "summary": "Delete a channel", "description": "Permanently delete a channel", "operationId": "deleteAlertChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "tags": [ "agent_Alerts" ], "summary": "Patch alert channel", "description": "Patch an alert channel", "operationId": "patchAlertChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "requestBody": { "description": "The JSON object representing the properties to set this channel with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PatchChannelApiEntity" }, "example": { "name": "kafka-prd-health", "connectionName": "slack-connection", "enabled": true, "properties": [ { "key": "channel", "value": "#my-kafka-health-prd" } ] } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/alert/channel-templates": { "get": { "tags": [ "agent_Alerts" ], "summary": "List alert channel templates", "description": "List channel templates and their applicable connections", "operationId": "listAlertChannelTemplates", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ChannelTemplate" } }, "example": [ { "id": 439, "name": "Slack", "templateVersion": 1, "version": "1", "enabled": true, "builtIn": true, "metadata": { "author": "Lenses", "description": "Slack channel template" }, "configuration": [ { "id": 102, "key": "channel", "displayName": "Channel Name", "description": "The slack channel where alerts should be notified to", "type": { "name": "STRING", "displayName": "string" }, "required": true, "provided": false } ], "suitableConnections": [ { "templateName": "Slack", "name": "slack-connection" } ], "jsonSchema": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "username", "channel", "className", "webhook-url" ], "title": "Slack, version: 1 template JSON schema", "properties": { "channel": { "type": "string", "title": "Slack channel", "description": "The Slack channel send alerts to." }, "icon-url": { "type": "string", "title": "Icon URL", "description": "The full path to an image to set for the slack message." }, "username": { "type": "string", "title": "Slack username", "description": "The user name to appear in slack as the sender." }, "webhook-url": { "type": "string", "title": "Webhook URL", "description": "The Slack endpoint to send alerts to." }, "className": { "type": "string", "title": "Plugin class name", "description": "Fully qualified class name of plugin implementation." } } } } ] } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/audit": { "get": { "tags": [ "agent_Audits" ], "summary": "List audit entries", "description": "Returns a list of audit entries", "operationId": "listAudits", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "user", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/agent_AuditChange" } }, { "name": "type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/agent_AuditResource" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Page_Audit" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Audits" ], "summary": "Delete audit entries up to timestamp", "description": "Deletes the audit entries up to the timestamp", "operationId": "deleteAudits", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timestamp", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/audit/values": { "get": { "tags": [ "agent_Audits" ], "summary": "Get audit metadata information", "description": "Returns the audits metadata information", "operationId": "getAuditMetadata", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_AuditMetadata" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/audit/channels": { "get": { "tags": [ "agent_Audits" ], "summary": "List audit channels", "description": "Lists audit channels ordered by their creation time (most recent first)", "operationId": "listAuditChannels", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "templateName", "in": "query", "description": "Filter by channel template name", "required": false, "schema": { "type": "string" } }, { "name": "channelName", "in": "query", "description": "Matches channels by name", "required": false, "schema": { "type": "string" } }, { "name": "sortField", "in": "query", "description": "The field to sort results by", "required": false, "schema": { "$ref": "#/components/schemas/agent_ChannelField" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order. Defaults to ascending", "required": false, "schema": { "$ref": "#/components/schemas/agent_Order" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Page_HttpChannelEntity" }, "example": { "values": [ { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "splunk-prd", "templateName": "Splunk", "templateVersion": 1, "connectionName": "splunk-connection", "properties": [ { "key": "source", "value": "splunk_source" } ], "createdAt": "2021-01-01T00:00:00Z", "createdBy": "joe.bloggs", "updatedAt": "2021-01-01T00:00:00Z", "updatedBy": "joe.bloggs", "enabled": true, "lrn": "lrn" } ], "pagesAmount": 1, "totalCount": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_Audits" ], "summary": "Create audit channel", "description": "The JSON object representing the properties to set this channel with", "operationId": "createAuditChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewChannelApiEntity" }, "example": { "name": "splunk-prd", "templateName": "Splunk", "connectionName": "splunk-connection", "properties": [ { "key": "source", "value": "splunk_source" } ] } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewChannelResponse" }, "example": { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/audit/channels/{id}": { "get": { "tags": [ "agent_Audits" ], "summary": "Get audit channel details", "description": "Get the audit channel details", "operationId": "getAuditChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpChannelEntity" }, "example": { "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd", "name": "splunk-prd", "templateName": "Splunk", "templateVersion": 1, "connectionName": "splunk-connection", "properties": [ { "key": "source", "value": "splunk_source" } ], "createdAt": "2021-01-01T00:00:00Z", "createdBy": "joe.bloggs", "updatedAt": "2021-01-01T00:00:00Z", "updatedBy": "joe.bloggs", "enabled": true, "lrn": "lrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Audits" ], "summary": "Update audit channel", "description": "Update audit channel", "operationId": "updateAuditChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "requestBody": { "description": "The JSON object representing the properties to set this channel with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_UpdateChannelApiEntity" }, "example": { "name": "splunk-prd", "connectionName": "splunk-connection", "properties": [ { "key": "source", "value": "splunk_source" } ] } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Audits" ], "summary": "Delete a channel", "description": "Permanently delete a channel", "operationId": "deleteAuditChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "patch": { "tags": [ "agent_Audits" ], "summary": "Patch audit channel", "description": "Patch an audit channel", "operationId": "patchAuditChannel", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The channel id", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd" } ], "requestBody": { "description": "The JSON object representing the properties to set this channel with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PatchChannelApiEntity" }, "example": { "name": "splunk-prd", "connectionName": "splunk-connection", "enabled": true, "properties": [ { "key": "source", "value": "splunk_source" } ] } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/audit/channel-templates": { "get": { "tags": [ "agent_Audits" ], "summary": "List audit channel templates", "description": "List channel templates and their applicable connections", "operationId": "listAuditChannelTemplates", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ChannelTemplate" } }, "example": [ { "id": 440, "name": "Splunk", "templateVersion": 1, "version": "1", "enabled": true, "builtIn": true, "metadata": { "author": "Lenses", "description": "Splunk channel template" }, "configuration": [ { "id": 102, "key": "source", "displayName": "Source", "placeholder": "lenses-audits", "description": "Source to associate with generated Splunk events", "type": { "name": "STRING", "displayName": "string" }, "required": true, "provided": false } ], "suitableConnections": [ { "templateName": "Splunk", "name": "splunk-connection" } ], "jsonSchema": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "source", "host", "useHttps", "insecure", "token" ], "title": "Splunk, version: 1 template JSON schema", "properties": { "source": { "type": "string", "title": "Source", "description": "Source to associate with generated Splunk events" }, "host": { "type": "string", "title": "Host", "description": "The host name for the HTTP Event Collector API of the Splunk instance." }, "useHttps": { "type": "boolean", "title": "Use HTTPS", "description": "Use SSL." }, "port": { "type": "number", "title": "Port", "description": "The port number for the HTTP Event Collector API of the Splunk instance." }, "token": { "type": "string", "title": "Event collector token", "description": "HTTP event collector authorization token" }, "insecure": { "type": "boolean", "title": "Disable SSL certificate verification", "description": "This is *not encouraged* but is required for a Splunk Cloud Trial instance." } } } } ] } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/acl": { "get": { "tags": [ "agent_Kafka" ], "summary": "Fetch Kafka Access Control Lists", "description": "Fetch Kafka Access Control Lists", "operationId": "listAcls", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpAcl" } } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Kafka" ], "summary": "Create or update a Kafka Access Control List", "description": "Create or update a Kafka Access Control List", "operationId": "addAcls", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Acl" }, "example": { "resourceType": "Topic", "resourceName": "trades", "patternType": "LITERAL", "principal": "User:Alice", "permissionType": "Allow", "host": "example.com", "operation": "Read" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Remove a Kafka Access Control List", "description": "Remove a Kafka Access Control List", "operationId": "deleteAcls", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpAcl" }, "example": { "resourceType": "Topic", "resourceName": "trades", "patternType": "LITERAL", "principal": "User:Alice", "permissionType": "Allow", "host": "example.com", "operation": "Read", "lrn": "kafka:acl:${Environment}/kafka/${AclResourceType}/${PrincipalType}/${Principal}" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas": { "get": { "tags": [ "agent_Kafka" ], "summary": "List Kafka quotas", "description": "Fetch all Kafka client quotas", "operationId": "listQuotas", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_QuotaResponse" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/users/{username}": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set user quota", "description": "Create or update a Kafka quota for a specific user", "operationId": "setUserQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to create the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete user quota", "description": "Delete quota properties for a specific user", "operationId": "deleteUserQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to delete the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id}": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set client quota", "description": "Create or update a Kafka quota for a specific client ID", "operationId": "setClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "client-id", "in": "path", "description": "The client id to create the quota for", "required": true, "schema": { "type": "string" }, "example": "app1" } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete client quota", "description": "Delete quota properties for a specific client ID", "operationId": "deleteClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "client-id", "in": "path", "description": "The client id to create the quota for", "required": true, "schema": { "type": "string" }, "example": "app1" } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set default client quota for user", "description": "Create or update the default Kafka quota for all clients of a specific user", "operationId": "setUserDefaultClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to delete the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete default client quota for user", "description": "Delete default quota properties for all clients of a specific user", "operationId": "deleteUserDefaultClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to delete the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/users": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set default user quota", "description": "Create or update the default Kafka quota for all users", "operationId": "setUserDefaultQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete default user quota", "description": "Delete default quota properties for all users", "operationId": "deleteUserDefaultQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/clients": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set default client quota", "description": "Create or update the default Kafka quota for all clients", "operationId": "setClientDefaultQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete default client quota", "description": "Delete default quota properties for all clients", "operationId": "deleteClientDefaultQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id}": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set user and client quota", "description": "Create or update a Kafka quota for a specific user and client ID combination", "operationId": "setUserAndClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to delete the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" }, { "name": "client-id", "in": "path", "description": "The client id to create the quota for", "required": true, "schema": { "type": "string" }, "example": "app1" } ], "requestBody": { "description": "A hashmap of property name/values ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Map_String_String" }, "example": { "producer_byte_rate": "100000", "consumer_byte_rate": "200000", "request_percentage": "75" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete user and client quota", "description": "Delete quota properties for a specific user and client ID combination", "operationId": "deleteUserAndClientQuota", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "path", "description": "The user to delete the quota for", "required": true, "schema": { "type": "string" }, "example": "jane" }, { "name": "client-id", "in": "path", "description": "The client id to create the quota for", "required": true, "schema": { "type": "string" }, "example": "app1" } ], "requestBody": { "description": "A list of properties", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "producer_byte_rate", "consumer_byte_rate", "request_percentage" ] } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{topic}/brokerConfigs": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get topic broker configurations (deprecated)", "description": "Retrieve broker configuration settings for a Kafka topic. This endpoint is deprecated.", "operationId": "getTopicBrokerConfigs", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_KafkaTopicConfigWithDefault" } } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/configs/topics/{topic}": { "put": { "tags": [ "agent_Kafka" ], "summary": "Set topic configuration", "description": "Update configuration settings for a Kafka topic", "operationId": "setTopicConfig", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetTopicConfiguration" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{p1}": { "get": { "tags": [ "agent_Kafka" ], "description": "Retrieve information about a given topic", "operationId": "getApiV1EnvironmentsEnvironmentProxyApiTopicsP1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "p1", "in": "path", "description": "Name of the topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpTopicSummary" } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{p1}/partitions": { "get": { "tags": [ "agent_Kafka" ], "description": "Retrieve a given topic partition details", "operationId": "getApiV1EnvironmentsEnvironmentProxyApiTopicsP1Partitions", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "p1", "in": "path", "description": "Name of the topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_Partition" } } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics": { "get": { "tags": [ "agent_Kafka" ], "summary": "List Kafka topics summary", "description": "Retrieve information about all topics", "operationId": "listKafkaTopicsSummary", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpTopicSummary" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_Kafka" ], "summary": "Create a Kafka topic", "description": "Create a new Kafka topic with the specified configuration", "operationId": "createKafkaTopic", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewTopicCommand" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/topics/{topic}/partitions": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic partitions", "description": "Retrieve information about partitions of a given topic", "operationId": "getKafkaTopicPartitions", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "Name of the topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PartitionDTO" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset}/resend": { "put": { "tags": [ "agent_Kafka" ], "summary": "Resend a Kafka message", "description": "Resend a kafka message", "operationId": "resendKafkaMessage", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "Name of the topic", "required": true, "schema": { "type": "string" } }, { "name": "partition", "in": "path", "description": "Kafka partition", "required": true, "schema": { "type": "integer" } }, { "name": "offset", "in": "path", "description": "Kafka offset", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_OutputPartitionOffset" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions": { "put": { "tags": [ "agent_Kafka" ], "summary": "Increase Kafka topic partitions", "description": "Increase the number of partitions for a Kafka topic", "operationId": "increaseKafkaTopicPartitions", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PartitionIncrease" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PartitionIncrease" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{topicName}/{partition}/{offset}": { "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete Kafka topic records", "description": "Delete records from a Kafka topic partition up to a specific offset", "operationId": "deleteKafkaTopicRecords", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partition", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "offset", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/topics/{topicName}": { "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete a Kafka topic", "description": "Delete a Kafka topic. The topic will be marked for deletion.", "operationId": "deleteKafkaTopic", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topics": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic details (deprecated)", "description": "Deprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.", "operationId": "getKafkaTopicDetailsV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpShortTopicSummary" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/kafka/topics": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topics details (deprecated)", "description": "Deprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.", "operationId": "getKafkaTopicsDetailsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "sortBy", "in": "query", "description": "The field to sort results by", "required": false, "schema": { "$ref": "#/components/schemas/agent_TopicField" } }, { "name": "sortingOrder", "in": "query", "description": "Sorting order. Defaults to ascending", "required": false, "schema": { "$ref": "#/components/schemas/agent_Order" } }, { "name": "name", "in": "query", "description": "Filter by topic name", "required": false, "schema": { "type": "string" } }, { "name": "includeSystemTopics", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TopicPage_HttpShortTopicSummary" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/kafka/topics/{topicName}": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic short summary", "description": "Returns a Kafka topic short summary", "operationId": "getKafkaTopicDetailsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpShortTopicSummary" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/key": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic key schema", "description": "Returns the schema associated with the topic key payload.\n", "operationId": "getKafkaTopicKeySchema", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The Kafka topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TopicSchema" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/value": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic value schema", "description": "Returns the schema associated with the topic value payload.\n", "operationId": "getKafkaTopicValueSchema", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The Kafka topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TopicSchema" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topic": { "post": { "tags": [ "agent_Kafka" ], "summary": "Create Kafka topic V1", "description": "For AVRO, JSON, CSV, and XML it is required to provide a schema, but not for primitives (INT, LONG, STRING, BYTES), custom Lenses serde or formats like SW*** and TW***.\nWhen using AVRO the schema will be registered with the Schema Registry and the process will fail if that step fails.", "operationId": "createKafkaTopicV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_CreateTopicRequestV1" } } }, "required": true }, "responses": { "201": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/backup": { "post": { "tags": [ "agent_Kafka", "agent_Kafka" ], "summary": "Backup Kafka topic to S3", "description": "Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.", "operationId": "backupKafkaTopicV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BackupTopicRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BackupRestoreResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/restore": { "post": { "tags": [ "agent_Kafka", "agent_Kafka" ], "summary": "Restore Kafka topic from S3", "description": "Restores data from S3 into the target topic.", "operationId": "restoreKafkaTopicV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RestoreTopicRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BackupRestoreResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName}": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get topic metadata", "description": "Retrieve metadata for a specific Kafka topic", "operationId": "getTopicMetadata", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "description": "Kafka Topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpTableMetadata" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete topic metadata", "description": "Delete metadata for a specific Kafka topic", "operationId": "deleteTopicMetadata", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topicName", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/metadata/topics": { "get": { "tags": [ "agent_Kafka" ], "summary": "List all topics metadata", "description": "Retrieve metadata for all Kafka topics", "operationId": "getTopicsMetadata", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpTableMetadata" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/metadata/topics": { "post": { "tags": [ "agent_Kafka" ], "summary": "Set topic metadata", "description": "Create or update metadata for a Kafka topic", "operationId": "setTopicMetadataV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TableMetadata" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy": { "get": { "tags": [ "agent_Kafka" ], "summary": "Get Kafka topic policy", "description": "Fetches the configured topic creation policy. A default one will be returned if no one exists", "operationId": "getKafkaTopicPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TopicPolicy" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_Kafka" ], "summary": "Set Kafka topic policy", "description": "Sets the topic creation policy", "operationId": "setKafkaTopicPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The desired Kafka topic creation policy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetTopicPolicy" }, "example": { "config": { "partitions": { "min": 1 }, "replication": { "min": 1 }, "retention": { "size": { "max": -1 }, "time": { "max": -1 } } }, "naming": { "pattern": "(prd|stg|dev)-.*", "description": "Env prefixed topic name" } } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/static/obfuscation": { "get": { "tags": [ "agent_DataPolicies" ], "summary": "List obfuscation types", "description": "Returns all data policies obfuscation types", "operationId": "listObfuscationTypes", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/static/impact": { "get": { "tags": [ "agent_DataPolicies" ], "summary": "List impact types", "description": "Returns all data policies impact level types", "operationId": "listImpactTypes", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/static/category": { "get": { "tags": [ "agent_DataPolicies" ], "summary": "List policy categories", "description": "Returns all data policies category types", "operationId": "listCategories", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/policy": { "get": { "tags": [ "agent_DataPolicies" ], "summary": "List data policies", "description": "Returns all the data policies rules entries", "operationId": "listDataPolicies", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_PolicyWithLrn" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_DataPolicies" ], "summary": "Create data policy", "description": "Adds a new data policy", "operationId": "createDataPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewPolicyRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/policy/{id}": { "get": { "tags": [ "agent_DataPolicies" ], "summary": "Get data policy", "description": "Returns the data policy details", "operationId": "getDataPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PolicyWithLrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_DataPolicies" ], "summary": "Update data policy", "description": "Updates an existing data policy", "operationId": "updateDataPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_UpdatePolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_DataPolicies" ], "summary": "Delete data policy", "description": "Deletes an existing data policy", "operationId": "deleteDataPolicy", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/protection/default/policy": { "post": { "tags": [ "agent_DataPolicies" ], "summary": "Load predefined data policies", "description": "Loads a default set of data policies entries covering used PII fields and obfuscation rules", "operationId": "createPreDefinedDataPolicies", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/approvals": { "get": { "tags": [ "agent_Approvals" ], "summary": "List approval requests", "description": "Returns a list of approval requests", "operationId": "listApprovalRequests", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "approvalStatus", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ApprovalStatus" } } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "sortField", "in": "query", "description": "The field to sort results by", "required": false, "schema": { "$ref": "#/components/schemas/agent_ApprovalRequestField" } }, { "name": "sortOrder", "in": "query", "description": "Sorting order. Defaults to ascending", "required": false, "schema": { "$ref": "#/components/schemas/agent_Order" } }, { "name": "entityName", "in": "query", "description": "filter request by matching entity names", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Page_Request" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_Approvals" ], "summary": "Create a new approval request", "description": "Creates a new approval request", "operationId": "createApprovalRequest", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NewRequest" }, "example": { "entityName": "topic-invoices", "entityType": "KafkaTopic", "settings": { "replication": 2, "partitions": 5, "topicConfig": { "delete.retention.ms": "30000" }, "capacity": { "recordsSize": 15 } }, "metadata": { "reason": "A topic to store invoice records produced by our billing app Foo", "tags": [ "billing", "invoices" ] }, "type": "CreateNewEntity" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_IdCreated" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}": { "get": { "tags": [ "agent_Approvals" ], "summary": "Get approval request details", "description": "Returns the approval request details", "operationId": "getApprovalRequest", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The request id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Request" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/approve": { "put": { "tags": [ "agent_Approvals" ], "summary": "Approve a request", "description": "Approves the request", "operationId": "approveRequest", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/reject": { "put": { "tags": [ "agent_Approvals" ], "summary": "Reject an approval request", "description": "Rejects the approval request", "operationId": "rejectRequest", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RejectionMessage" } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets": { "get": { "tags": [ "agent_Datasets" ], "summary": "List datasets", "description": "Retrieves a list of datasets", "operationId": "listDatasets", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number to be returned, must be greater than zero. Defaults to 1.", "required": false, "schema": { "type": "integer" }, "example": 1 }, { "name": "pageSize", "in": "query", "description": "The elements amount on a single page, must be greater than zero.", "required": true, "schema": { "type": "integer" }, "example": 25 }, { "name": "query", "in": "query", "description": "A search keyword to match dataset, fields and description against.", "required": false, "schema": { "type": "string" }, "example": "name" }, { "name": "connections", "in": "query", "description": "A list of connection names to filter by. All connections will be included when no value is supplied.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags", "in": "query", "description": "A list of tag names to filter by. All tags will be included when no value is supplied.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortBy", "in": "query", "description": "The field to sort results by", "required": false, "schema": { "$ref": "#/components/schemas/agent_DatasetField" } }, { "name": "sortingOrder", "in": "query", "description": "Sorting order. Defaults to ascending", "required": false, "schema": { "$ref": "#/components/schemas/agent_Order" } }, { "name": "includeSystemEntities", "in": "query", "description": "A flag to include in the search also system entities (e.g. Kafka's `__consumer_offsets` topic).", "required": false, "schema": { "type": "boolean" } }, { "name": "includeMetadata", "in": "query", "description": "Whether to search only by table name, or also to include field names/documentation (defaults to true)", "required": false, "schema": { "type": "boolean" } }, { "name": "format", "in": "query", "description": "Schema format. Relevant only when sourceType is `SchemaRegistrySubject`", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "hasRecords", "in": "query", "description": "Filter based on whether the dataset has records", "required": false, "schema": { "type": "boolean" } }, { "name": "compacted", "in": "query", "description": "Filter based on compacted. Relevant only when sourceType is `Kafka`", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "A response wrapping a paginated list of datasets and the set of relative source types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Results" }, "example": { "datasets": { "values": [ { "name": "telecom_italia", "highlights": [], "records": 80000000, "recordsPerSecond": 1813, "keyType": "AVRO", "valueType": "AVRO", "connectionName": "Kafka", "replication": 1, "consumers": 0, "partitions": 6, "fields": { "key": [], "value": [ { "type": "STRING", "name": "name", "typeDetails": { "lensesDataType": "STRING", "kind": "Lenses" }, "ancestors": [], "highlights": [ { "fieldName": "name", "startIndex": 1, "endIndex": 5, "arrayIndex": 0 } ], "isNullable": false } ] }, "isSystemEntity": false, "isMarkedForDeletion": false, "isCompacted": false, "sizeBytes": 25, "policies": [], "permissions": [ "ShowTopic" ], "tags": [], "retentionMs": 604800000, "retentionBytes": 1073741824, "backupRestoreState": "backup-restore", "lrn": "kafka:topic:my-env/kafka/telecom_italia", "sourceType": "Kafka" } ], "pagesAmount": 1, "totalCount": 2 }, "sourceTypes": [ "Kafka" ] } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/bulk/datasets/delete": { "post": { "tags": [ "agent_Datasets" ], "summary": "Bulk delete datasets", "description": "Deletes multiple datasets at once", "operationId": "bulkDeleteDatasets", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body contains a list of datasets to delete. The dataset name should be prefixed with the connection alias name, for example: alias://datasetname", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BulkDeleteRequest" }, "example": { "items": [ { "id": "kafka://telecom_italia" }, { "id": "kafka://bank" } ] } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BulkDeleteResult" }, "example": { "items": [ { "id": "telecom_italia", "success": true }, { "id": "bank", "success": false, "message": "Dataset not found" } ] } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/description": { "put": { "tags": [ "agent_Datasets" ], "summary": "Set dataset description", "description": "Sets a dataset description. Will respond with a bad request if a blank description is supplied", "operationId": "setDatasetDescription", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "connection", "in": "path", "required": true, "schema": { "type": "string" }, "example": "kafka" }, { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "user_details" } ], "requestBody": { "description": "A non-blank dataset description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetDescription" }, "example": { "description": "Details about user's purchase history" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/tags": { "put": { "tags": [ "agent_Datasets" ], "summary": "Set dataset tags", "description": "Add one or more tags to a dataset", "operationId": "setDatasetTags", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "connection", "in": "path", "required": true, "schema": { "type": "string" }, "example": "kafka" }, { "name": "datasetName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "user_details" } ], "requestBody": { "description": "The list of tags to be set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetTags" }, "example": { "tags": [ { "name": "crm" }, { "name": "PII" }, { "name": "legacy" } ] } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{dataset}": { "get": { "tags": [ "agent_Datasets" ], "summary": "Get dataset details", "description": "Get a single dataset by connection/name. While information mastered externally might be \n a few second out of sync with their respective sources (e.g. JMX metadata, etc), information mastered in Lenses's db is guaranteed to be up to date (e.g. \ntags, descriptions).", "operationId": "getDataset", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "connection", "in": "path", "required": true, "schema": { "type": "string" }, "example": "kafka" }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string" }, "example": "customer-positions" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_DatasetMatchWithLrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/tags": { "get": { "tags": [ "agent_Datasets" ], "summary": "Get dataset tags", "description": "Get tags sorted by dataset count", "operationId": "getDatasetTags", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Match tag by keyword", "required": false, "schema": { "type": "string" }, "example": "user" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_TagCounts" }, "example": { "tags": [ { "name": "user-generated-content", "count": 5 }, { "name": "user-details", "count": 2 }, { "name": "testuser", "count": 1 } ] } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/connections": { "get": { "tags": [ "agent_Datasets" ], "summary": "Get dataset connections", "description": "Get a list of available dataset connections", "operationId": "getConnectionDatasets", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Match connection by keyword", "required": false, "schema": { "type": "string" }, "example": "kafka" }, { "name": "perPage", "in": "query", "description": "Number of results to be returned. Defaults to 25 if not supplied", "required": false, "schema": { "type": "integer" }, "example": 50 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_DatasetConnections" }, "example": { "connections": [ { "name": "kafka", "sourceType": "Kafka", "connectionStatus": "Green" }, { "name": "kafka-reconcilation.dev", "sourceType": "Kafka", "connectionStatus": "Yellow" } ] } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/config": { "get": { "tags": [ "agent_SchemaRegistry" ], "summary": "Get default compatibility mode", "description": "Get the default compatibility mode", "operationId": "getDefaultCompatibility", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Config" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "put": { "tags": [ "agent_SchemaRegistry" ], "summary": "Set default compatibility mode", "description": "Set the default compatibility mode", "operationId": "setDefaultCompatibility", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetConfig" } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/formats": { "get": { "tags": [ "agent_SchemaRegistry" ], "summary": "Get schema formats", "description": "Get the set of schema formats used in this specific collection of subjects", "operationId": "getFormats", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_UsedFormatsResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/config": { "put": { "tags": [ "agent_SchemaRegistry" ], "summary": "Set subject compatibility mode", "description": "Set/unset a subject's compatibility mode", "operationId": "setSubjectCompatibility", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_name", "in": "path", "description": "The subject name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetConfig" } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/current-version": { "put": { "tags": [ "agent_SchemaRegistry" ], "summary": "Create schema", "description": "Register a new Schema version, creating a subject it doesn't exist", "operationId": "createSchema", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_name", "in": "path", "description": "The subject name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RegisterSchemaRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RegisterSchemaResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{subject_name}/version/{p1}": { "delete": { "tags": [ "agent_SchemaRegistry" ], "summary": "Delete schema version", "description": "Deletes a specific Schema Registry subject version", "operationId": "deleteSchemaVersion", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_name", "in": "path", "description": "The subject name", "required": true, "schema": { "type": "string" } }, { "name": "p1", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sr/default/subject/{p1}": { "delete": { "tags": [ "agent_SchemaRegistry" ], "summary": "Delete schema subject", "description": "Deletes a subject from Schema Registry", "operationId": "deleteSchema", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "p1", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/datasets/kafka/{entityName}/messages/metrics": { "get": { "tags": [ "agent_Datasets" ], "summary": "Get dataset ranged metrics", "description": "get ranged metrics for requested dataset", "operationId": "getDatasetRangedMetrics", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityName", "in": "path", "description": "Dataset's entity name", "required": true, "schema": { "type": "string" }, "example": "topic" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_DailyMessages" } } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers": { "get": { "tags": [ "agent_Kafka" ], "summary": "List Kafka consumer groups", "description": "Returns the list of Kafka consumer groups", "operationId": "listKafkaConsumerGroups", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpConsumersGroupInfoShort" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{topic}": { "get": { "tags": [ "agent_Kafka" ], "summary": "List consumer groups for a topic", "description": "Returns the consumer groups which are using the given topic", "operationId": "listKafkaConsumerGroupsForTopic", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpConsumersGroupInfoShort" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "deprecated": true, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition}": { "put": { "tags": [ "agent_Kafka" ], "summary": "Update consumer group offset", "description": "Updates the offset for a topic-partition for the given group", "operationId": "setKafkaConsumerGroupOffset", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "The consumer group id", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } }, { "name": "partition", "in": "path", "description": "The topic partition number", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SinglePartitionOffsetRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets": { "put": { "tags": [ "agent_Kafka" ], "summary": "Update consumer group offsets", "description": "Update the offset for a consumer group topic-partition tuples", "operationId": "setKafkaConsumerGroupOffsets", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "The consumer group id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BulkPartitionOffsetRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{consumerGroupName}": { "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete a consumer group", "description": "Returns the consumer groups which are using the given topic", "operationId": "deleteKafkaConsumerGroups", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "consumerGroupName", "in": "path", "description": "The consumer group name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets": { "delete": { "tags": [ "agent_Kafka" ], "summary": "Delete consumer group offset", "description": "Delete the offset for a topic-partition for the given group", "operationId": "deleteKafkaConsumerGroupOffset", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "The consumer group id", "required": true, "schema": { "type": "string" } }, { "name": "topic", "in": "path", "description": "The topic name", "required": true, "schema": { "type": "string" } }, { "name": "partition", "in": "path", "description": "The topic partition number", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/delete": { "post": { "tags": [ "agent_Kafka" ], "summary": "Delete multiple consumer group offsets", "description": "Delete the offset for a consumer group topic-partition tuples", "operationId": "deleteMultipleKafkaConsumerGroupOffsets", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "The consumer group id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BulkPartitionOffsetDeleteRequest" } } }, "required": false }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/files": { "post": { "tags": [ "agent_Connections" ], "summary": "Upload a file", "description": "Upload a file", "operationId": "uploadFile", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/agent_MultiPartBody" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_FileMetadataEntity" }, "example": { "id": "45447f25-3ad2-441d-b849-49bf696606b8", "filename": "keystore.jks", "uploadedBy": "user", "uploadedAt": "2021-01-01T00:00:00Z", "size": 1024, "contentType": "application/x-java-keystore" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/external": { "post": { "tags": [ "agent_ApplicationsManagement" ], "summary": "Register external app", "description": "Register External Apps or App Runners. This endpoint is used to register a brand new app, or to update an existing one with more Runners", "operationId": "registerExternalApp", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ExternalApplicationRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName}": { "delete": { "tags": [ "agent_ApplicationsManagement" ], "summary": "Delete external app", "description": "Remove External Apps. This action will remove the external app as well as all the instances of the App", "operationId": "deleteExternalApp", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appName", "in": "path", "description": "The unique identifier for the app", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/external/{appName}/runners": { "delete": { "tags": [ "agent_ApplicationsManagement" ], "summary": "Delete external app runners", "description": "Remove External App Runners. This action will remove the runners from its App", "operationId": "deleteExternalAppRunners", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appName", "in": "path", "description": "The unique identifier for the app", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RemoveRunnersRequest" } } }, "required": true }, "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/streams": { "get": { "tags": [ "agent_SqlStreaming" ], "summary": "List SQL Processors", "description": "Returns a list of all registered SQL processors with their current states, configurations, and metadata. Results are filtered based on the caller's permissions.", "operationId": "listSqlProcessorsV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpListSqlProcessorsApiResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_SqlStreaming" ], "summary": "Create SQL Processor", "description": "Registers and creates a new SQL processor with the provided configuration. The processor executes streaming SQL queries against Kafka topics. Returns the processor ID and initial state upon successful creation.", "operationId": "createSqlProcessorV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RegisterProcessorApiRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RegisterProcessorApiResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams": { "get": { "tags": [ "agent_SqlStreaming" ], "summary": "List SQL Processors (Legacy)", "description": "Legacy endpoint for listing SQL processors. Use the V2 endpoint for new integrations which provides enhanced response format.", "operationId": "listSqlProcessorsV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpListSqlProcessorsLegacyApiResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_SqlStreaming" ], "summary": "Create SQL Processor (Legacy)", "description": "Legacy endpoint for creating SQL processors. Use the V2 endpoint for new integrations. Returns the processor ID as a string.", "operationId": "createSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_RegisterProcessorLegacyApiRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}": { "get": { "tags": [ "agent_SqlStreaming" ], "summary": "Get SQL Processor (Legacy)", "description": "Legacy endpoint for retrieving SQL processor details. Use the V2 endpoint for new integrations which provides enhanced response format.", "operationId": "getSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpGetSqlProcessorLegacyApiResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_SqlStreaming" ], "summary": "Delete SQL Processor", "description": "Permanently removes a SQL processor and its associated resources. The processor must be in a stopped state before deletion. Returns the deleted processor ID.", "operationId": "deleteSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v2/streams/{id}": { "get": { "tags": [ "agent_SqlStreaming" ], "summary": "Get SQL Processor", "description": "Retrieves detailed information about a specific SQL processor including its configuration, current state, SQL query, input/output topics, and runtime metrics.", "operationId": "getSqlProcessorV2", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpGetSqlProcessorApiResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/graph": { "get": { "tags": [ "agent_SqlStreaming" ], "summary": "Get SQL Processor Graph", "description": "Returns the DAG (Directed Acyclic Graph) representation of the SQL processor's topology, showing the flow of data through operators, sources, and sinks.", "operationId": "getSqlProcessorsGraphV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ProcessorGraphResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/start": { "put": { "tags": [ "agent_SqlStreaming" ], "summary": "Start SQL Processor", "description": "Initiates execution of a SQL processor that is in a stopped or created state. The processor will begin consuming from input topics and producing to output topics. Returns 202 Accepted as the operation is asynchronous.", "operationId": "startSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/resume": { "put": { "tags": [ "agent_SqlStreaming" ], "summary": "Resume SQL Processor", "description": "Resumes a previously stopped SQL processor from its last committed offset. Unlike start, resume continues processing from where it left off rather than resetting offsets. Returns 202 Accepted as the operation is asynchronous.", "operationId": "resumeSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/stop": { "put": { "tags": [ "agent_SqlStreaming" ], "summary": "Stop SQL Processor", "description": "Gracefully stops a running SQL processor. The processor will commit its current offsets before stopping, allowing it to be resumed later. Returns 202 Accepted as the operation is asynchronous.", "operationId": "stopSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/scale/{scale}": { "put": { "tags": [ "agent_SqlStreaming" ], "summary": "Scale SQL Processor", "description": "Adjusts the number of parallel runner instances for a SQL processor to increase or decrease throughput. Only available for Kubernetes deployments. The scale value must be a positive integer.", "operationId": "scaleSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "scale", "in": "path", "description": "The new SQL processor runner count. It has to be an integer bigger than zero.", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "string", "minLength": 1 } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/streams/{id}/image": { "put": { "tags": [ "agent_SqlStreaming" ], "summary": "Change SQL Processor Docker Image", "description": "Updates the Docker image used by a SQL processor's runners. This allows upgrading or changing the processor runtime without recreating the processor. The processor should be stopped before changing the image.", "operationId": "changeImageSqlProcessorV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "SQL processor unique identifier", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ChangeDockerImageRequest" } } }, "required": true }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ChangeDockerImageResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/description": { "put": { "tags": [ "agent_ApplicationsManagement" ], "summary": "Set application description", "description": "Sets an application description. Will respond with a bad request if a blank description is supplied", "operationId": "setAppDescription", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 }, "example": "application-id" } ], "requestBody": { "description": "A non-blank application description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetDescriptionRequest" }, "example": { "description": "Aggregates distances by driver" } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/tags": { "get": { "tags": [ "agent_ApplicationsManagement" ], "summary": "List application tags", "description": "Get applications tags filtered by a matching supplied query", "operationId": "listAppsTags", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "Match tag by keyword", "required": false, "schema": { "type": "string" }, "example": "user" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ApplicationTagsResponse" }, "example": { "tags": [ "user-generated-content", "user-details", "testuser" ] } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/apps/{applicationId}/tags": { "put": { "tags": [ "agent_ApplicationsManagement" ], "summary": "Set application tags", "description": "Annotates an application with a list of tags. Will respond with a bad request if tags are empty, contain whitespaces or ar longer than 255", "operationId": "setAppTags", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 }, "example": "application-id" } ], "requestBody": { "description": "A list of non-blank application tags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_SetTagsRequest" }, "example": { "tags": [ "aggregation" ] } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/k8s/logs/{cluster}/{namespace}/{pod}/download": { "get": { "tags": [ "agent_Deployments" ], "summary": "Get pod logs", "description": "Returns the logs produced by a running Kubernetes Pod", "operationId": "getPodLogs", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "description": "Pod's cluster", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "namespace", "in": "path", "description": "Pod's namespace", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "pod", "in": "path", "description": "Pod's name", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "headers": { "Content-Disposition": { "required": true, "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/deployment/targets": { "get": { "tags": [ "agent_Deployments" ], "summary": "List deployments information", "description": "Returns deployments information", "operationId": "listDeployments", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ClustersInfoWithLrn" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sql/queries": { "get": { "tags": [ "agent_SqlSnapshot" ], "summary": "List SQL Snapshot Queries", "description": "Returns all currently active SQL snapshot query executions. Each entry includes the query ID, SQL statement, execution start time, and current progress. Useful for monitoring and managing long-running queries.", "operationId": "listSqlSnapshotQueries", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ExecutionView" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sql/execution/{queryId}": { "delete": { "tags": [ "agent_SqlSnapshot" ], "summary": "Stop SQL Snapshot Query", "description": "Cancels an in-progress SQL snapshot query execution. The query will be terminated and resources released. Use the query ID returned from the execute endpoint to identify the query to cancel.", "operationId": "stopSqlSnapshotQuery", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queryId", "in": "path", "description": "The SQL Snapshot query identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sql/paging": { "get": { "tags": [ "agent_SqlSnapshot" ], "summary": "Get Topic Paging Details", "description": "Returns partition-level offset information for a Kafka topic, including the earliest and latest offsets for each partition. This information is useful for understanding data availability and planning query ranges.", "operationId": "getKafkaTopicDataPagingDetails", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table", "in": "query", "description": "The target table", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_Paging" } } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/sql/presentation": { "post": { "tags": [ "agent_SqlSnapshot" ], "summary": "Get Snapshot SQL Intellisense", "description": "Provides code completion, syntax validation, and schema suggestions for snapshot SQL queries. Returns available tables, columns, functions, and SQL keywords based on the cursor position. Supports multiple data connections.", "operationId": "getSnapshotIntellisenseV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PresentationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Presentation" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/intellisense/streams/kafka": { "post": { "tags": [ "agent_SqlStreaming" ], "summary": "Get Streaming SQL Intellisense", "description": "Provides code completion, syntax validation, and schema suggestions for streaming SQL queries against Kafka topics. Returns completions, errors, and metadata based on the cursor position in the query.", "operationId": "getStreamingIntellisenseV1", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_PresentationRequest1" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_IntellisenseResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/metadata": { "get": { "tags": [ "agent_Metadata" ], "operationId": "getMetadata", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Metadata1" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/s3/backups/{id}": { "get": { "tags": [ "agent_BackupRestore" ], "summary": "Get backup/restore item details", "description": "Get a backup/restore item details", "operationId": "getBackupRestoreItem", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier held by the backup Lenses store", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BackupRestoreItem" } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_BackupRestore" ], "summary": "Delete a backup/restore item", "description": "Delete a backup/restore item", "operationId": "deleteBackupRestoreItem", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The unique identifier held by the backup Lenses store", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/s3/backups": { "get": { "tags": [ "agent_BackupRestore" ], "summary": "List all backup/restore items", "description": "List all backup/restore items", "operationId": "listBackupRestoreItems", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/agent_BackupRestoreItem" } } } } }, "400": { "description": "The request input was invalid", "content": { "text/plain": { "schema": { "type": "string" } } } }, "401": { "description": "Authentication error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "text/plain": { "schema": { "type": "string" } } } }, "403": { "description": "Authorisation error", "content": { "text/plain": { "schema": { "type": "string" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "text/plain": { "schema": { "type": "string" } } } }, "500": { "description": "An internal server error has occurred", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/state": { "get": { "tags": [ "agent_ProvisioningState" ], "summary": "Get provisioning state information", "description": "Gets the provisioning state information (DEPRECATED: Use GET /api/v1/state/connections instead)", "operationId": "viewProvisioningState", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ViewStateAPIResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/state/connections": { "get": { "tags": [ "agent_ProvisioningState" ], "summary": "Get raw provisioning file contents", "description": "Gets the raw provisioning.yaml file contents", "operationId": "getProvisionedConnections", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/state/connections/upload": { "post": { "tags": [ "agent_ProvisioningState" ], "summary": "Upload complete provisioning manifest with files", "description": "Uploads a complete provisioning manifest as YAML along with referenced files to the configured scanner folder. This replaces the entire connection state - any existing connections not in the manifest will be deleted. If no 'lensesHq' section is provided in the manifest, the existing HQ connection will be automatically preserved.", "operationId": "putProvisioningConnectionsWithFiles", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ProvisioningValidationResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "409": { "description": "The supplied identifier is already being used by another resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Conflict" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/state/connections/validate/upload": { "post": { "tags": [ "agent_ProvisioningState" ], "summary": "Validate provisioning manifest with files", "description": "Validates a provisioning manifest with uploaded files without applying changes. Uses full upload validation (replaces entire state).", "operationId": "validateProvisioningConnectionsWithFiles", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_ProvisioningValidationResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector/{connector-name}": { "get": { "tags": [ "agent_AsCode" ], "summary": "Get connector resource definition", "description": "Fetches the current target definition for a connector", "operationId": "getResourceConnector", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "connect-cluster-name", "in": "path", "required": true, "schema": { "type": "string" }, "example": "cluster" }, { "name": "connector-name", "in": "path", "required": true, "schema": { "type": "string" }, "example": "connector" } ], "responses": { "200": { "description": "", "content": { "application/yaml": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/resource": { "put": { "tags": [ "agent_AsCode" ], "summary": "Apply a resource spec", "description": "Applies a given resource spec.", "operationId": "putResource", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/yaml": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "201": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/v1/resource/resource-file-upload": { "put": { "tags": [ "agent_AsCode" ], "summary": "Apply a resource spec from files", "description": "Applies a given resource spec.", "operationId": "putResourceFiles", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "201": { "description": "" }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/connectors": { "get": { "tags": [ "agent_Kafka Connect" ], "operationId": "List Connectors", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "className", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpDataResponse_HttpConnectorListItem" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "post": { "tags": [ "agent_Kafka Connect" ], "operationId": "Create Connector", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpNewConnector" }, "example": { "name": "connector", "cluster": "cluster", "configuration": { "connector.class": "org...FileStreamSinkConnector" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}": { "get": { "tags": [ "agent_Kafka Connect" ], "operationId": "Get Connector", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpConnectorDetails" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] }, "delete": { "tags": [ "agent_Kafka Connect" ], "operationId": "Delete Connector", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/plugins": { "get": { "tags": [ "agent_Kafka Connect" ], "operationId": "List Plugins", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpDataResponse_HttpConnectPluginItem" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/{action}": { "put": { "tags": [ "agent_Kafka Connect" ], "operationId": "Connector State", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "action", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/agent_ConnectorStateSet" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/tasks/{p1}/restart": { "put": { "tags": [ "agent_Kafka Connect" ], "operationId": "Connector Task Restart", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "connector", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "p1", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } }, "/api/v1/environments/{environment}/proxy/api/kafka-connect/validate": { "post": { "tags": [ "agent_Kafka Connect" ], "operationId": "Validate Connector", "parameters": [ { "name": "environment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpValidateConnector" }, "example": { "name": "connector", "cluster": "cluster", "configuration": { "connector.class": "org...FileStreamSinkConnector" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_HttpConnectorValidationResponse" } } } }, "400": { "description": "The request input was invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_BadRequest" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Unauthorized" } } } }, "402": { "description": "The purchased Lenses license does not provide access to this feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_LicenseError" } } } }, "403": { "description": "Authorisation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_Forbidden" } } } }, "404": { "description": "The requested resource cannot be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_NotFound" } } } }, "500": { "description": "An internal server error has occurred", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agent_InternalError" } } } } }, "security": [ { "bearerAuth": [] }, { "cookieAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "The bearer token can be obtained by creating a ServiceAccount.\n" }, "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "session_id", "description": "On successful SAML/SSO login, the API will set a cookie with a session id.\n" } }, "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", "ai_server_unavailable", "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" ] }, "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" } } }, "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_EnvironmentList": { "type": "object", "description": "Contains a list of Environments.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_Environment" } } }, "required": [ "items" ] }, "hq_EnvironmentLiveEventType": { "type": "string", "description": "Enumerates environment live event names emitted over SSE.", "enum": [ "initial", "upsert", "delete" ] }, "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_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" ] }, "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_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_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" } ], "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" } } }, "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", "truststore" ] }, "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": { "$ref": "#/components/schemas/hq_K8sTruststoreRef" } }, "required": [ "kubernetes_namespace_lrn", "mechanism", "credentials", "truststore" ] }, "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_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_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_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-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-ca-cert\", with key\n\"ca.crt\" the \"truststore\" itself.\n", "allOf": [ { "$ref": "#/components/schemas/hq_KubernetesSecretKeyReference" }, { "type": "object", "properties": {} } ] }, "hq_SASLMechanism": { "type": "string", "description": "Enumerates supported SASL mechanisms.", "enum": [ "plain", "scram_sha_256", "scram_sha_512" ] }, "hq_KafkaConnectionList": { "type": "object", "description": "Contains a list of KafkaConnections.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_KafkaConnection" } } }, "required": [ "items" ] }, "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_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_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" } }, "required": [ "agent_key" ] } ] }, "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_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_CompactGroupList": { "type": "object", "description": "Contains a list of CompactGroups.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_CompactGroup" } } }, "required": [ "items" ] }, "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_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", "x-lenses-go-nullable-slice": true, "items": { "type": "string" } }, "metadata": { "$ref": "#/components/schemas/hq_MetadataPatchRequest" } } }, "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_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": {} }, "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": {} }, "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_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 } } }, "hq_UserList": { "type": "object", "description": "Contains a list of Users.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_User" } } }, "required": [ "items" ] }, "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_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_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_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", "x-lenses-go-nullable-slice": true, "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" } } } }, "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_ServiceAccountList": { "type": "object", "description": "Contains a list of ServiceAccounts.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_ServiceAccount" } } }, "required": [ "items" ] }, "hq_ServiceAccountWithSecretToken": { "allOf": [ { "$ref": "#/components/schemas/hq_ServiceAccount" }, { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] } ] }, "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_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_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_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." } } }, "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_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_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_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_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.", "x-lenses-go-nullable-slice": true, "items": { "$ref": "#/components/schemas/hq_PermissionStatement" } }, "metadata": { "$ref": "#/components/schemas/hq_MetadataPatchRequest" } } }, "hq_CompactRoleList": { "type": "object", "description": "Contains a list of CompactRoles.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/hq_CompactRole" } } }, "required": [ "items" ] }, "hq_PermissionStatement": { "x-lenses-custom-validator": true, "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_PermissionActionScalarOrList": { "x-lenses-go-type": "PermissionActionScalarOrList", "description": "Is either a single action or a list of actions.", "oneOf": [ { "type": "string" }, { "type": "array", "minItems": 1, "items": { "type": "string" } } ] }, "hq_PermissionResourceScalarOrList": { "x-lenses-go-type": "PermissionResourceScalarOrList", "description": "Is either a single string or a list of strings.", "oneOf": [ { "type": "string" }, { "type": "array", "minItems": 1, "items": { "type": "string" } } ] }, "hq_PermissionEffect": { "type": "string", "description": "Enumerates permission effects.", "enum": [ "allow", "deny" ] }, "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" ] }, "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_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, "x-lenses-go-type": "*string" } }, "hq_Settings": { "type": "object", "description": "Contains application settings.", "properties": { "api": { "$ref": "#/components/schemas/hq_APIConfig" } }, "required": [ "api" ] }, "hq_APIConfig": { "type": "object", "properties": { "saml": { "$ref": "#/components/schemas/hq_SAMLConfig" } }, "required": [ "saml" ] }, "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_LoginRequest": { "type": "object", "description": "Bundles a username/password for authentication purposes.", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] }, "hq_Licence": { "type": "object", "description": "Models a licence.", "properties": { "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" } }, "required": [ "tier", "features", "limits" ] }, "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_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" ] }, "hq_LicenceTier": { "type": "string", "description": "Enumerates licence tiers.", "enum": [ "community", "enterprise" ] }, "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" ] }, "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" } } }, "required": [ "topic_metrics", "updated_at", "state", "error_message", "source_topics", "destination_topics", "errors" ] }, "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_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_K2KSourceThroughput": { "type": "object", "description": "Aggregates throughput metrics for a source topic.", "properties": { "updated_at": { "type": "string", "format": "date-time" }, "bytes_per_second": { "type": "number", "format": "double" }, "records_per_second": { "type": "number", "format": "double" } }, "required": [ "updated_at", "bytes_per_second", "records_per_second" ] }, "hq_K2KDestinationThroughput": { "type": "object", "description": "Aggregates throughput metrics for a destination topic.", "properties": { "updated_at": { "type": "string", "format": "date-time" }, "bytes_per_second": { "type": "number", "format": "double" }, "records_per_second": { "type": "number", "format": "double" } }, "required": [ "updated_at", "bytes_per_second", "records_per_second" ] }, "hq_K2KSourceOffsets": { "type": "object", "description": "Aggregates offsets data for a source topic.", "properties": { "updated_at": { "type": "string", "format": "date-time" }, "partitions": { "type": "array", "items": { "$ref": "#/components/schemas/hq_K2KSourcePartitionOffsets" } } }, "required": [ "updated_at", "partitions" ] }, "hq_K2KDestinationOffsets": { "type": "object", "description": "Aggregates offsets and lag data for a destination topic.", "properties": { "updated_at": { "type": "string", "format": "date-time" }, "partitions": { "type": "array", "items": { "$ref": "#/components/schemas/hq_K2KDestinationPartitionOffsets" } } }, "required": [ "updated_at", "partitions" ] }, "hq_K2KSourcePartitionOffsets": { "type": "object", "description": "Groups log end offsets per source partition.", "properties": { "partition": { "type": "integer", "format": "int64", "example": 0 }, "log_end_offset": { "type": "integer", "format": "int64" } }, "required": [ "partition", "log_end_offset" ] }, "hq_K2KDestinationPartitionOffsets": { "type": "object", "description": "Groups log end offsets and lag data per destination partition.", "properties": { "partition": { "type": "integer", "example": 0 }, "log_end_offset": { "type": "integer", "format": "int64" }, "lag": { "type": "integer", "format": "int64" } }, "required": [ "partition", "log_end_offset" ] }, "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_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_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_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_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_K2KUpdateOffsetsRequest": { "type": "object", "description": "Defines the request body for updating K2K offsets, containing an array of topic-partition-offset tuples.", "properties": { "offsets": { "type": "array", "description": "An array of topic-partition-offset tuples specifying the new offset positions.", "items": { "$ref": "#/components/schemas/hq_K2KTopicPartitionOffset" } } }, "required": [ "offsets" ] }, "hq_K2KUpdateOffsetsByTimestampRequest": { "type": "object", "description": "Defines the request body for updating K2K offsets based on a timestamp for multiple topics.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "RFC3339 timestamp to seek offsets to.", "example": "2025-01-14T10:03:00Z" }, "topics": { "type": "array", "description": "List of Kafka topic names to update offsets for.", "items": { "type": "string" }, "minItems": 1, "example": [ "user-login-events", "orders", "payments" ] } }, "required": [ "timestamp", "topics" ] }, "hq_K2KUpdateOffsetsResponse": { "type": "object", "properties": { "application_name": { "type": "string", "example": "my-app-prod" }, "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_name": { "type": "string", "description": "The name of the Kafka topic.", "example": "user-login-events" }, "partition": { "type": "integer", "format": "int32", "description": "The partition number for the given topic.", "minimum": 0, "example": 0 }, "offset": { "type": "integer", "format": "int64", "description": "The offset value to set for the given topic-partition.", "minimum": 0, "example": 12345 } }, "required": [ "topic_name", "partition", "offset" ] }, "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_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.", "example": "environments:kafka-connection/my-source-environment/plaintext" }, "targetKafkaLRN": { "type": "string", "format": "environments-kafka-connection-lrn", "description": "Sets the target KafkaConnection LRN to write to.", "example": "environments:kafka-connection/my-target-environment/plaintext" }, "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.", "example": "kubernetes:namespace/my-environment/incluster/my-namespace" }, "replicas": { "type": "integer" }, "kubernetes": { "$ref": "#/components/schemas/hq_K8sDeploymentOverrides" }, "replicator": { "$ref": "#/components/schemas/hq_K2KReplicatorSettings" }, "paused": { "type": "boolean", "description": "Halts replication by scaling down to zero pods." }, "configOverrides": { "$ref": "#/components/schemas/hq_K2KConfigOverrides" } }, "required": [ "sourceKafkaLRN", "targetKafkaLRN", "deploymentNamespaceLRN", "topics" ] }, "hq_K2KConfigOverrides": { "type": "object", "description": "Contains arbitrary data that gets merged into the replicator's config.", "additionalProperties": {} }, "hq_K2KErrorHandlingBehavior": { "type": "string", "description": "Specifies error handling behavior.", "enum": [ "fail", "ignore" ] }, "hq_K2KErrorHandlingSettings": { "type": "object", "description": "Controls K2K error handling behavior.", "properties": { "onCommitSyncTimeout": { "$ref": "#/components/schemas/hq_K2KErrorHandlingBehavior" }, "onControlMessageDeserializationError": { "$ref": "#/components/schemas/hq_K2KErrorHandlingBehavior" } } }, "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_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_K2KCoordinationSettings": { "type": "object", "description": "Controls coordination behavior.", "properties": { "commit": { "$ref": "#/components/schemas/hq_K2KCommitCoordinationSettings" }, "assignment": { "$ref": "#/components/schemas/hq_K2KAssignmentCoordinationSettings" } } }, "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_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_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_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_K2KAppKafkaStatus": { "type": "object", "properties": { "consumerGroup": { "type": "string", "description": "Holds the name of the consumer group that this K2KApp uses." } }, "required": [ "consumerGroup" ] }, "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_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_K8sResourceList": { "type": "object", "description": "Mirrors a K8s core v1 ResourceList.", "properties": { "cpu": { "type": "string", "format": "K8sResourceQuantity" }, "memory": { "type": "string", "format": "K8sResourceQuantity" } } }, "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_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.", "x-lenses-validate": "K8sUID" }, "runAsGroup": { "type": "integer", "format": "int64", "description": "Sets the GID to run the entrypoint of the container process.", "x-lenses-validate": "K8sGID" }, "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_K8sStringMap": { "x-lenses-custom-validator": true, "type": "object", "description": "Maps string keys to string values. Used for K8s labels and annotations.", "additionalProperties": { "type": "string" } }, "hq_K2KAppState": { "type": "string", "description": "Enumerates K2KApp state types.", "enum": [ "deploying", "starting", "running", "paused", "error", "deleting" ] }, "hq_K2KAppMetricsState": { "type": "string", "description": "Enumerates K2KApp metrics states.", "enum": [ "unknown", "success", "error" ] }, "hq_Order": { "type": "string", "enum": [ "asc", "desc" ] }, "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" ] }, "hq_DatasetResults": { "required": [ "datasets" ], "type": "object", "properties": { "datasets": { "$ref": "#/components/schemas/hq_Page_DatasetMatch" }, "sourceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/hq_SourceType" } } } }, "hq_SourceType": { "type": "string", "enum": [ "Kafka", "Elastic", "Postgres", "SchemaRegistrySubject" ] }, "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_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_DatasetTagsList": { "required": [ "tags" ], "type": "object", "description": "List of tags saved in one agent.", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/hq_DatasetTag" } } } }, "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_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_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_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" } } }, "hq_Application": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/hq_ApplicationType" } } }, "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_ApplicationType": { "type": "string", "enum": [ "AkkaStreams", "LsqlProcessor", "KafkaStreams", "SparkStreaming", "ConnectSource", "ConnectSink", "Other" ] }, "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_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_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_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_BackupRestore": { "type": "object" }, "hq_Backup": { "type": "object" }, "hq_Restore": { "type": "object" }, "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_PolicyFieldMatch": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "parents": { "type": "array", "items": { "type": "string" } } } }, "hq_StatementPos": { "required": [ "index", "start", "end" ], "type": "object", "properties": { "index": { "type": "integer" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "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_HintType": { "type": "string", "enum": [ "Warning", "Error", "Obfuscation", "Info", "Security" ] }, "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_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_PresentationRequest": { "required": [ "sql" ], "type": "object", "properties": { "sql": { "type": "string" }, "caret": { "type": "integer" }, "connectorId": { "type": "string" } } }, "hq_TableName": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "hq_FieldName": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "hq_TableFields": { "required": [ "tableName" ], "type": "object", "properties": { "tableName": { "$ref": "#/components/schemas/hq_TableName" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/hq_FieldName" } } } }, "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_SinglePartitionOffsetRequest": { "required": [ "offset", "type" ], "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "type": { "type": "string" } } }, "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" } } } } }, "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" } } }, "hq_ClustersInfo": { "type": "object", "properties": { "kubernetes": { "type": "array", "items": { "$ref": "#/components/schemas/hq_KubernetesCluster" } }, "connect": { "type": "array", "items": { "$ref": "#/components/schemas/hq_ConnectCluster" } } } }, "hq_AgentProvisioning": { "type": "string" }, "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" } } }, "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" ] }, "hq_CheckPoisonPillRequest": { "type": "object", "description": "Contains fields for checking poison pill.", "properties": { "topicLRN": { "type": "string", "format": "kafka-topic-lrn", "description": "Contains the topic LRN." }, "partition": { "type": "integer", "description": "Holds the partition to check." }, "offset": { "type": "integer", "format": "int64", "description": "Is set to the offset to check." }, "lag": { "type": "integer", "description": "Is the lag to check, if provided." } }, "required": [ "topicLRN", "partition", "offset" ] }, "hq_CheckPoisonPillResponse": { "type": "object", "description": "Contains the response of the poison pill check.", "properties": { "content": { "type": "string", "description": "Provides the AI response in plain text." } }, "required": [ "content" ] }, "hq_GenerateYAMLFilesResponse": { "type": "object", "required": [ "conversation_id" ], "properties": { "content": { "type": "string", "description": "Contains the actual YAML content." }, "conversation": { "type": "string", "description": "Provides the message to be sent to the user." }, "conversation_id": { "type": "string", "description": "Holds the associated conversation ID." }, "file_name": { "type": "string", "description": "Specifies the file name." }, "missing_fields": { "type": "array", "items": { "type": "string" }, "description": "Lists the required fields that are missing." } } }, "hq_BulkPartitionOffsetRequest": { "oneOf": [ { "$ref": "#/components/schemas/hq_PartitionOffsetEnd" }, { "$ref": "#/components/schemas/hq_PartitionOffsetStart" }, { "$ref": "#/components/schemas/hq_PartitionOffsetTimestamp" } ] }, "hq_BulkPartitionOffsetRequestType": { "type": "string", "description": "Enumerates possible request types.", "enum": [ "start", "end", "timestamp" ] }, "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 } } }, "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": {}, "hq_Decoders": { "required": [ "keys", "values" ], "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "string" } }, "values": { "type": "array", "items": { "type": "string" } } } }, "hq_BackupRestoreResponse": { "required": [ "id", "connector", "cluster" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "connector": { "type": "string" }, "cluster": { "type": "string" } } }, "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" } } }, "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_S3StorageFormat": { "type": "string", "enum": [ "avro", "parquet", "json" ] }, "hq_PartitionIncrease": { "required": [ "partitions" ], "type": "object", "properties": { "partitions": { "type": "integer" } } }, "hq_ConnectionSummaryResponse": { "required": [ "name", "templateName", "templateVersion", "deletable" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "templateVersion": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } }, "deletable": { "type": "boolean", "description": "Can the connection be deleted" } } }, "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)" } } }, "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_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_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" } } }, "hq_SetConfig": { "required": [ "compatibility" ], "type": "object", "properties": { "compatibility": { "type": "string" } } }, "hq_RegisterSchemaRequest": { "required": [ "schema" ], "type": "object", "properties": { "schema": { "type": "string" }, "format": { "type": "string" } } }, "hq_RegisterSchemaResponse": { "required": [ "version", "schemaId" ], "type": "object", "properties": { "version": { "type": "integer" }, "schemaId": { "type": "string" } } }, "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_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" } } }, "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_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 ] }, "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" } } }, "hq_AlertEventsResponse": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/hq_AlertEvent" } }, "pagesAmount": { "type": "integer" }, "totalCount": { "type": "integer" } } }, "hq_AlertConditionChannelRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "templateName": { "type": "string" } } }, "hq_AlertConditionThreshold": { "type": "object", "properties": { "type": { "type": "string" }, "messages": { "type": "integer" } } }, "hq_AlertConditionDsl": { "type": "object", "properties": { "connectionName": { "type": "string" }, "datasetName": { "type": "string" }, "threshold": { "$ref": "#/components/schemas/hq_AlertConditionThreshold" }, "duration": { "type": "string" } } }, "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_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" } } } }, "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_AlertChannelsResponse": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/hq_AlertChannel" } }, "pagesAmount": { "type": "integer" }, "totalCount": { "type": "integer" } } }, "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_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_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_AlertChannelCreatedResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "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" } } }, "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_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" ] }, "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_AuditEntriesResponse": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/hq_AuditEntry" } }, "pagesAmount": { "type": "integer" }, "totalCount": { "type": "integer" } } }, "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_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_AuditChannelsResponse": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/hq_AuditChannel" } }, "pagesAmount": { "type": "integer" }, "totalCount": { "type": "integer" } } }, "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_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_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_AuditChannelCreatedResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "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" } } }, "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_ChannelProperty": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "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" } } }, "hq_KafkaAclRequest": { "type": "object", "required": [ "resourceType", "resourceName", "principal", "permissionType", "host", "operation" ], "properties": { "resourceType": { "type": "string", "example": "Topic" }, "resourceName": { "type": "string", "example": "trades" }, "patternType": { "type": "string", "example": "LITERAL" }, "principal": { "type": "string", "example": "User:Alice" }, "permissionType": { "type": "string", "example": "Allow" }, "host": { "type": "string", "example": "example.com" }, "operation": { "type": "string", "example": "Read" } } }, "hq_KafkaAclDeleteRequest": { "type": "object", "required": [ "resourceType", "resourceName", "principal", "permissionType", "host", "operation", "lrn" ], "properties": { "resourceType": { "type": "string", "example": "Topic" }, "resourceName": { "type": "string", "example": "trades" }, "patternType": { "type": "string", "example": "LITERAL" }, "principal": { "type": "string", "example": "User:Alice" }, "permissionType": { "type": "string", "example": "Allow" }, "host": { "type": "string", "example": "example.com" }, "operation": { "type": "string", "example": "Read" }, "lrn": { "type": "string", "example": "kafka:acl:${Environment}/kafka/Topic/LITERAL/trades/User:Alice/Allow/example.com/Read" } } }, "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" } } }, "hq_KafkaQuotaProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Quota properties as key-value pairs" }, "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" } } }, "hq_TopicPolicy": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/hq_TopicPolicyConfig" }, "naming": { "$ref": "#/components/schemas/hq_TopicPolicyNaming" } } }, "hq_TopicPolicyRequest": { "type": "object", "required": [ "config" ], "properties": { "config": { "$ref": "#/components/schemas/hq_TopicPolicyConfig" }, "naming": { "$ref": "#/components/schemas/hq_TopicPolicyNaming" } } }, "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_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 } } }, "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 } } }, "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" } } }, "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_SQLProcessorV2Response": { "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/hq_SQLProcessorV1Target" } }, "streams": { "type": "array", "items": { "$ref": "#/components/schemas/hq_SQLProcessorV2" } } } }, "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" } } } }, "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_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" } } }, "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_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" } } }, "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" } } }, "hq_SQLProcessorV1Target": { "type": "object", "properties": { "cluster": { "type": "string" }, "version": { "type": "string" }, "namespaces": { "type": "array", "items": { "type": "string" } } } }, "hq_SQLProcessorV1ListResponse": { "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/hq_SQLProcessorV1Target" } }, "streams": { "type": "array", "items": { "$ref": "#/components/schemas/hq_SQLProcessorV1" } } } }, "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" } } } }, "hq_SQLProcessorImageRequest": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string" } } }, "hq_SQLIntellisenseRequest": { "type": "object", "required": [ "sql", "caret" ], "properties": { "sql": { "type": "string" }, "caret": { "type": "integer" } } }, "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_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_SQLIntellisenseLint": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" }, "text": { "type": "string" }, "type": { "type": "string", "enum": [ "Warning", "Error", "Info" ] } } }, "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" } } }, "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" } } }, "hq_ExternalAppRunnersDeleteRequest": { "type": "object", "required": [ "runners" ], "properties": { "runners": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "A list of runners urls" } } }, "hq_ApplicationDescriptionRequest": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 } } }, "hq_ApplicationTagsRequest": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, "hq_ApplicationTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, "agent_AWSGlueSchemaRegistryConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration" } } }, "agent_AWSGlueSchemaRegistryConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfigurationV2" } } }, "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" ] } } }, "agent_AWSGlueSchemaRegistryConnectionConfigurationV2": { "required": [ "authMode", "glueRegistryArn" ], "type": "object", "properties": { "accessKeyId": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "AKIAIOSFODNN7EXAMPLE" } }, "description": "Access key ID of an AWS IAM account", "example": "AKIAIOSFODNN7EXAMPLE" }, "secretAccessKey": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" } }, "description": "Secret access key of an AWS IAM account", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "sessionToken": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "AQoDYXdzEJr..." } }, "description": "Specifies the session token value that is required if you are using temporary security credentials that you retrieved directly from AWS STS operations", "example": "AQoDYXdzEJr..." }, "authMode": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "AWS-connection-1" } }, "description": "Way to authenticate against AWS", "example": "AWS-connection-1" }, "assumeRoleArn": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "arn:aws:glue:eu-west-1:ACCOUNT_A_ID:schema-registry/GlueSRDemo" } }, "description": "The Amazon Resource Name (ARN) of the IAM role to assume using AWS STS", "example": "arn:aws:glue:eu-west-1:ACCOUNT_A_ID:schema-registry/GlueSRDemo" }, "assumeRoleSessionName": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": "string", "example": "GlueSchemaAccess" } }, "description": "An identifier for the assumed role session, used to uniquely distinguish sessions when assuming the same role multiple times", "example": "GlueSchemaAccess" }, "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" ] } } } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_AWSGlueSchemaRegistryConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_AWSGlueSchemaRegistryConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_AWSGlueSchemaRegistryConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfiguration" } } }, "agent_AWSGlueSchemaRegistryConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_AWSGlueSchemaRegistryConnectionConfigurationV2" } } }, "agent_Absolute": { "required": [ "offset" ], "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" } } }, "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" } } }, "agent_AddConnectionApiRequestV2": { "required": [ "name", "templateName" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka", "minLength": 1 }, "configuration": { "type": "object", "description": "The configuration of the connection. The schema of this object is defined by the [template configuration](#operation/listConnectionTemplates)" } } }, "agent_AddConnectionResponse": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" } } }, "agent_AlertConditionRequest": { "required": [ "condition" ], "type": "object", "properties": { "condition": { "oneOf": [ { "$ref": "#/components/schemas/agent_JsonObject" }, { "type": "string" } ] }, "channels": { "type": "array", "items": { "type": "string" } } } }, "agent_AlertConditionResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "agent_AlertRuleDetails": { "oneOf": [ { "$ref": "#/components/schemas/agent_ConditionalAlertRuleDetails" }, { "$ref": "#/components/schemas/agent_FixedAlertRuleDetails" } ] }, "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 ] }, "agent_AlertSettingPatchRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "channels": { "type": "array", "items": { "type": "string" } }, "config": { "$ref": "#/components/schemas/agent_JsonObject" } } }, "agent_AlertSettingPutRequest": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "channels": { "type": "array", "items": { "type": "string" } }, "config": { "$ref": "#/components/schemas/agent_JsonObject" } } }, "agent_AlertSettingResponse": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } } }, "agent_AlertType": { "type": "string", "enum": [ "Fixed", "Conditional" ] }, "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_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_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_ApplicationInputOutputEntry": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Node Name" } } }, "agent_ApplicationTagsResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } } } }, "agent_ApplicationType": { "type": "string", "enum": [ "AkkaStreams", "LsqlProcessor", "KafkaStreams", "SparkStreaming", "ConnectSource", "ConnectSink", "Other" ] }, "agent_ApprovalRequestField": { "type": "string", "enum": [ "entityName", "createdBy", "createdAt" ] }, "agent_ApprovalStatus": { "type": "string", "enum": [ "Approved", "Pending", "Rejected", "Failed" ] }, "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_AuditChange": { "type": "string", "enum": [ "ADD", "REMOVE", "UPDATE", "PATCH", "INSERT", "STARTED", "STOPPED", "SCALED", "RESTARTED", "PAUSED", "VIEWED", "LOGIN", "LOGOUT", "REQUESTED", "REJECTED", "APPROVED", "FAILED", "UNKNOWN" ] }, "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_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_Backup": { "type": "object" }, "agent_BackupFlushSettings": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "size": { "type": "integer", "format": "int64" }, "interval": { "type": "integer", "format": "int64" } } }, "agent_BackupRestore": { "type": "object" }, "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_BackupRestoreResponse": { "required": [ "id", "connector", "cluster" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "connector": { "type": "string" }, "cluster": { "type": "string" } } }, "agent_BackupRestoreState": { "oneOf": [ { "$ref": "#/components/schemas/agent_Backup" }, { "$ref": "#/components/schemas/agent_BackupRestore" }, { "$ref": "#/components/schemas/agent_Restore" } ] }, "agent_BackupRestoreType": { "type": "string", "enum": [ "Backup", "Restore" ] }, "agent_BackupTopicRequest": { "required": [ "cluster", "s3" ], "type": "object", "properties": { "cluster": { "type": "string" }, "s3": { "$ref": "#/components/schemas/agent_S3Bucket" }, "flush": { "$ref": "#/components/schemas/agent_BackupFlushSettings" } } }, "agent_BadRequest": { "required": [ "error" ], "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "error": { "type": "string" }, "errorType": { "type": "string" } } }, "agent_BulkDeleteRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/agent_BulkDeleteRequestItem" } } } }, "agent_BulkDeleteRequestItem": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } }, "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" } } }, "agent_BulkPartitionOffsetDeleteRequest": { "required": [ "topics" ], "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "agent_BulkPartitionOffsetRequest": { "oneOf": [ { "$ref": "#/components/schemas/agent_End1" }, { "$ref": "#/components/schemas/agent_Start1" }, { "$ref": "#/components/schemas/agent_Timestamp" } ] }, "agent_Capacity": { "type": "object", "properties": { "recordsSize": { "type": "integer" }, "dataProducedPerDay": { "type": "integer" }, "consumers": { "type": "integer" } } }, "agent_Category": { "type": "string", "enum": [ "Infrastructure", "Consumers", "Kafka Connect", "Topics", "Data Produced", "Apps" ] }, "agent_ChangeDockerImageRequest": { "required": [ "image" ], "type": "object", "properties": { "image": { "type": "string", "minLength": 1 } } }, "agent_ChangeDockerImageResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } } }, "agent_ChannelField": { "type": "string", "enum": [ "name", "templateName", "createdAt", "updatedAt" ] }, "agent_ChannelSummary": { "required": [ "id", "name", "templateName" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "templateName": { "type": "string" } } }, "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_ClustersInfoWithLrn": { "type": "object", "properties": { "kubernetes": { "type": "array", "items": { "$ref": "#/components/schemas/agent_KubernetesClusterWithLrn" } }, "connect": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectClusterWithLrn" } } } }, "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_ConditionalAlertRuleDetails": { "required": [ "conditions", "alertType" ], "type": "object", "properties": { "conditions": { "$ref": "#/components/schemas/agent_Map_UUID_ConditionDetails" }, "alertType": { "$ref": "#/components/schemas/agent_AlertType" } } }, "agent_Config": { "type": "object", "properties": { "compatibility": { "type": "string" } } }, "agent_Conflict": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "type": "string" } } }, "agent_ConnectClusterWithLrn": { "required": [ "cluster", "version", "lrn" ], "type": "object", "properties": { "cluster": { "type": "string" }, "version": { "type": "string" }, "lrn": { "type": "string" } } }, "agent_ConnectStatus": { "type": "string", "enum": [ "RUNNING", "UNASSIGNED", "PAUSED", "FAILED", "RESTARTING", "STOPPED" ] }, "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_ConnectionJsonResponseV2WithLrn": { "required": [ "name", "lrn", "templateVersion", "templateName", "builtIn", "createdBy", "createdAt", "modifiedBy", "modifiedAt", "configuration", "deletable" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "lrn": { "type": "string", "description": "A Lenses resource name identifier", "example": "Lenses Resource Name" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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" } } }, "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_ConnectionStateResponse": { "required": [ "name", "version" ], "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "integer" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "agent_ConnectionStatus": { "type": "string", "enum": [ "Green", "Yellow", "Red" ] }, "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" } } }, "agent_ConnectionTemplateMetadata": { "required": [ "author" ], "type": "object", "properties": { "author": { "type": "string" }, "description": { "type": "string" } } }, "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", "example": "Kafka" }, "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_ConnectorStateSet": { "type": "string", "enum": [ "start", "stop", "restart", "pause", "resume" ] }, "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_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_CreateTopicDataFormatV1": { "required": [ "format" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/agent_DecoderType" }, "schema": { "type": "string" } } }, "agent_CreateTopicMessageFormatV1": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "$ref": "#/components/schemas/agent_CreateTopicDataFormatV1" }, "value": { "$ref": "#/components/schemas/agent_CreateTopicDataFormatV1" } } }, "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_DailyMessages": { "required": [ "date" ], "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "messagesCount": { "type": "integer", "format": "int64" } } }, "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_DatasetConnections": { "type": "object", "properties": { "connections": { "type": "array", "items": { "$ref": "#/components/schemas/agent_DatasetConnectionResult" } } } }, "agent_DatasetField": { "type": "string", "enum": [ "name", "records", "connectionName", "sourceType", "isSystemEntity", "recordsPerSecond", "keyType", "valueType", "replication", "consumers", "partitions", "retentionBytes", "retentionMs", "sizeBytes", "version", "format", "compatibility", "backupRestoreState" ] }, "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_DatasetTag": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "agent_DatasetTag1": { "required": [ "name" ], "type": "object", "properties": { "name": { "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" ] }, "agent_DefaultMax": { "required": [ "max" ], "type": "object", "properties": { "default": { "type": "integer", "format": "int64" }, "max": { "type": "integer", "format": "int64" } } }, "agent_DefaultTopicConfigs": { "required": [ "default", "serverDefaultProperties", "description" ], "type": "object", "properties": { "default": { "type": "string" }, "serverDefaultProperties": { "type": "string" }, "description": { "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_DeploymentDescriptionRequest": { "oneOf": [ { "$ref": "#/components/schemas/agent_KubernetesDeployment" }, { "$ref": "#/components/schemas/agent_LensesDeployment" } ] }, "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_End": { "type": "object" }, "agent_End1": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "agent_EntityType": { "type": "string", "enum": [ "KafkaTopic" ] }, "agent_ExecutionStatus": { "type": "string", "enum": [ "Completed", "Killed", "Running" ] }, "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_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_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_FieldError": { "required": [ "field", "error" ], "type": "object", "properties": { "field": { "type": "string" }, "error": { "type": "string" }, "lineNumber": { "type": "integer" }, "columnNumber": { "type": "integer" } } }, "agent_FieldName": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "agent_FieldTypeDetails": { "oneOf": [ { "$ref": "#/components/schemas/agent_Lenses" }, { "$ref": "#/components/schemas/agent_Native" } ] }, "agent_Fields": { "type": "object", "properties": { "key": { "type": "array", "items": { "$ref": "#/components/schemas/agent_Field" } }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/agent_Field" } } } }, "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" } } }, "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_Forbidden": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "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_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_HintType": { "type": "string", "enum": [ "Warning", "Error", "Obfuscation", "Info", "Security" ] }, "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" } } }, "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_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_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_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_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" } } }, "agent_HttpCategorisedAlertRules": { "required": [ "categories" ], "type": "object", "properties": { "categories": { "$ref": "#/components/schemas/agent_Map_Category_List_HttpAlertRule" } } }, "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_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" } } }, "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_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_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" } } }, "agent_HttpConnectorValidationResponse": { "required": [ "class" ], "type": "object", "properties": { "class": { "type": "string" }, "configuration": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpConnectorValidationField" } } } }, "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_HttpDataResponse_HttpConnectPluginItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpConnectPluginItem" } } } }, "agent_HttpDataResponse_HttpConnectorListItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpConnectorListItem" } } } }, "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_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_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_HttpListSqlProcessorsApiResponse": { "type": "object", "properties": { "processors": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpGetSqlProcessorApiResponse" } } } }, "agent_HttpListSqlProcessorsLegacyApiResponse": { "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/agent_Target" } }, "streams": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpGetSqlProcessorLegacyApiResponse" } } } }, "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_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_HttpSimpleTaskItem": { "required": [ "id", "state" ], "type": "object", "properties": { "id": { "type": "integer" }, "state": { "$ref": "#/components/schemas/agent_ConnectStatus" } } }, "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_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_HttpValidateConnector": { "required": [ "name", "cluster", "configuration" ], "type": "object", "properties": { "name": { "type": "string" }, "cluster": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/agent_Map_String_String" } } }, "agent_IdCreated": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } }, "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_ImpactType": { "type": "string", "enum": [ "HIGH", "MEDIUM", "LOW" ] }, "agent_InformationCoverage": { "type": "string", "enum": [ "full", "partial" ] }, "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_InternalError": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "type": "string" } } }, "agent_Json": {}, "agent_JsonObject": { "type": "object", "description": "JSON Schema representation of the configuration properties" }, "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_KafkaConnectConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionConfiguration" } } }, "agent_KafkaConnectConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionConfigurationV2" } } }, "agent_KafkaConnectConnectionConfiguration": { "required": [ "workers" ], "type": "object", "properties": { "workers": { "type": "array", "items": { "type": "string" }, "description": "List of Kafka Connect worker URLs", "example": [ "http://connect1:8083" ] }, "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", "example": "user" }, "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)", "example": 9581 }, "metricsSsl": { "type": "boolean", "description": "Flag to enable SSL for metrics connections" }, "metricsUsername": { "type": "string", "description": "The username for metrics connections", "example": "username" }, "metricsPassword": { "type": "string", "description": "The password for metrics connections", "format": "password" }, "metricsHttpSuffix": { "type": "string", "description": "HTTP URL suffix for Jolokia metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "type": "integer", "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "type": "object", "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "http://connect1:8083": "connect1_jmx:9584" }, "additionalProperties": { "type": "string" } }, "metricsCustomPortMappings": { "type": "object", "description": "DEPRECATED", "additionalProperties": { "type": "string" } }, "metricsRateLimitingMaxRetries": { "type": "integer", "description": "HTTP retries when 429 is returned for Jolokia metrics", "example": 5 }, "metricsRateLimitingBackoff": { "type": "integer", "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "agent_KafkaConnectConnectionConfigurationV2": { "required": [ "workers" ], "type": "object", "properties": { "workers": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "example": [ "http://connect1:8083" ] } }, "description": "List of Kafka Connect worker URLs", "example": [ "http://connect1:8083" ] }, "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", "example": "user" } }, "description": "Username for HTTP Basic Authentication", "example": "user" }, "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", "example": 9581 } }, "description": "Default port number for metrics connection (JMX and JOLOKIA)", "example": 9581 }, "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", "example": "username" } }, "description": "The username for metrics connections", "example": "username" }, "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", "example": "/jolokia" } }, "description": "HTTP URL suffix for Jolokia metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "example": { "http://connect1:8083": "connect1_jmx:9584" }, "additionalProperties": { "type": "string" } } }, "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "http://connect1:8083": "connect1_jmx:9584" } }, "metricsCustomPortMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "DEPRECATED" }, "metricsRateLimitingMaxRetries": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5 } }, "description": "HTTP retries when 429 is returned for Jolokia metrics", "example": 5 }, "metricsRateLimitingBackoff": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 30000 } }, "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_KafkaConnectConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KafkaConnectConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KafkaConnectConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionConfiguration" } } }, "agent_KafkaConnectConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KafkaConnectConnectionConfigurationV2" } } }, "agent_KafkaConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KafkaConnectionConfiguration" } } }, "agent_KafkaConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KafkaConnectionConfigurationV2" } } }, "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.", "example": [ "PLAINTEXT://kafka1:9092" ] }, "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", "example": "GSSAPI" }, "saslJaasConfig": { "type": "string", "description": "JAAS Login module configuration for SASL", "format": "password", "example": "com.sun.security.auth.module.Krb5LoginModule required\n useKeyTab=true\n storeKey=true\n useTicketCache=false\n serviceName=\"kafka\"\n principal=\"principal@MYREALM\";" }, "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)", "example": 9581 }, "metricsSsl": { "type": "boolean", "description": "Flag to enable SSL for metrics connections" }, "metricsUsername": { "type": "string", "description": "The username for metrics connections", "example": "username" }, "metricsPassword": { "type": "string", "description": "The password for metrics connections", "format": "password" }, "metricsHttpSuffix": { "type": "string", "description": "HTTP URL suffix for Jolokia or AWS metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "type": "integer", "description": "HTTP Request timeout (ms) for Jolokia or AWS metrics", "example": 5000 }, "metricsCustomUrlMappings": { "type": "object", "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "kafka1:9092": "kafka1_jmx:9581" }, "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", "example": 5 }, "metricsRateLimitingBackoff": { "type": "integer", "description": "The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics", "example": 30000 } } }, "agent_KafkaConnectionConfigurationV2": { "required": [ "kafkaBootstrapServers" ], "type": "object", "properties": { "kafkaBootstrapServers": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "example": [ "PLAINTEXT://kafka1:9092" ] } }, "description": "Comma separated list of protocol://host:port to use for initial connection to Kafka.", "example": [ "PLAINTEXT://kafka1:9092" ] }, "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", "example": "GSSAPI" } }, "description": "Mechanism to use when authenticated using SASL", "example": "GSSAPI" }, "saslJaasConfig": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "format": "password", "example": "com.sun.security.auth.module.Krb5LoginModule required\n useKeyTab=true\n storeKey=true\n useTicketCache=false\n serviceName=\"kafka\"\n principal=\"principal@MYREALM\";" } }, "description": "JAAS Login module configuration for SASL", "example": "com.sun.security.auth.module.Krb5LoginModule required\n useKeyTab=true\n storeKey=true\n useTicketCache=false\n serviceName=\"kafka\"\n principal=\"principal@MYREALM\";" }, "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", "example": 9581 } }, "description": "Default port number for metrics connection (JMX and JOLOKIA)", "example": 9581 }, "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", "example": "username" } }, "description": "The username for metrics connections", "example": "username" }, "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", "example": "/jolokia" } }, "description": "HTTP URL suffix for Jolokia or AWS metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "HTTP Request timeout (ms) for Jolokia or AWS metrics", "example": 5000 }, "metricsCustomUrlMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "example": { "kafka1:9092": "kafka1_jmx:9581" }, "additionalProperties": { "type": "string" } } }, "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "kafka1:9092": "kafka1_jmx:9581" } }, "metricsCustomPortMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "DEPRECATED" }, "metricsRateLimitingMaxRetries": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5 } }, "description": "HTTP retries when 429 is returned for Jolokia or AWS metrics", "example": 5 }, "metricsRateLimitingBackoff": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 30000 } }, "description": "The backoff interval (ms) when 429 is returned for Jolokia or AWS metrics", "example": 30000 } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_KafkaConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KafkaConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KafkaConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KafkaConnectionConfiguration" } } }, "agent_KafkaConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KafkaConnectionConfigurationV2" } } }, "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" } } }, "agent_KerberosConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KerberosConnectionConfiguration" } } }, "agent_KerberosConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KerberosConnectionConfigurationV2" } } }, "agent_KerberosConnectionConfiguration": { "required": [ "kerberosKrb5" ], "type": "object", "properties": { "kerberosKrb5": { "required": [ "fileId" ], "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" } }, "description": "Kerberos krb5.conf file" } } }, "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" } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_KerberosConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KerberosConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_KerberosConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_KerberosConnectionConfiguration" } } }, "agent_KerberosConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_KerberosConnectionConfigurationV2" } } }, "agent_KeyDataType": { "type": "string", "description": "The data type of the property", "enum": [ "STRING", "ARRAY", "MULTILINE", "SECRET", "DOUBLE", "LONG", "BOOLEAN", "BASE64", "ENUM", "MAP" ] }, "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_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_LastAction": { "required": [ "action", "msg" ], "type": "object", "properties": { "action": { "$ref": "#/components/schemas/agent_RunnerAction" }, "msg": { "type": "string" } } }, "agent_Lenses": { "required": [ "lensesDataType" ], "type": "object", "properties": { "lensesDataType": { "type": "string" } } }, "agent_LensesDeployment": { "type": "object" }, "agent_LicenseError": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "type": "string" } } }, "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_Map_Category_List_HttpAlertRule": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/agent_HttpAlertRule" } } }, "agent_Map_Refined_Refined": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 } }, "agent_Map_Refined_String": { "type": "object", "additionalProperties": { "type": "string" } }, "agent_Map_String_DefaultTopicConfigs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/agent_DefaultTopicConfigs" } }, "agent_Map_String_List_ConnectionStateResponse": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ConnectionStateResponse" } } }, "agent_Map_String_Runner": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/agent_Runner1" } }, "agent_Map_String_String": { "type": "object", "additionalProperties": { "type": "string" } }, "agent_Map_UUID_ConditionDetails": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/agent_ConditionDetails" } }, "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_Metadata": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "agent_Metadata1": { "required": [ "version", "instance" ], "type": "object", "properties": { "version": { "type": "string" }, "instance": { "type": "string" } } }, "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_MinMaybeMax": { "required": [ "min" ], "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" } } }, "agent_MultiPartBody": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "agent_NamingStrategy": { "required": [ "pattern", "description" ], "type": "object", "properties": { "pattern": { "type": "string" }, "description": { "type": "string" } } }, "agent_Native": { "required": [ "native", "lensesDataType" ], "type": "object", "properties": { "native": { "type": "string" }, "lensesDataType": { "type": "string" } } }, "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_NewChannelResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } }, "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_NewRequest": { "oneOf": [ { "$ref": "#/components/schemas/agent_CreateNewEntity" }, { "$ref": "#/components/schemas/agent_DeleteExistingEntity" }, { "$ref": "#/components/schemas/agent_UpdateExistingEntity" } ] }, "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_NodeType": { "type": "string", "enum": [ "PreDaDProcessor", "Stream", "Table", "Topic", "Sink" ] }, "agent_NotFound": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "type": "string" } } }, "agent_Order": { "type": "string", "enum": [ "asc", "desc" ] }, "agent_OutputPartitionOffset": { "required": [ "partition", "offset" ], "type": "object", "properties": { "partition": { "type": "integer" }, "offset": { "type": "integer", "format": "int64" } } }, "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_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_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_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_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_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_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_PagingType": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "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_Partition1": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int64" } } }, "agent_PartitionDTO": { "type": "object", "properties": { "partitions": { "type": "array", "items": { "$ref": "#/components/schemas/agent_PartitionV2" } }, "jmxLastRetrievedAt": { "type": "string", "format": "date-time" } } }, "agent_PartitionIncrease": { "required": [ "partitions" ], "type": "object", "properties": { "partitions": { "type": "integer" } } }, "agent_PartitionReplica": { "required": [ "broker", "leader", "inSync" ], "type": "object", "properties": { "broker": { "type": "integer" }, "leader": { "type": "boolean" }, "inSync": { "type": "boolean" } } }, "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_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_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_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_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_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_PresentationRequest": { "required": [ "sql" ], "type": "object", "properties": { "sql": { "type": "string" }, "caret": { "type": "integer" }, "connectorId": { "type": "string" } } }, "agent_PresentationRequest1": { "required": [ "sql" ], "type": "object", "properties": { "sql": { "type": "string" }, "caret": { "type": "integer" } } }, "agent_ProcessorApiStatus": { "type": "string", "enum": [ "NOT_RUNNING", "RUNNING", "WARNING", "FAILED", "PENDING" ] }, "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_ProcessorGraphResponse": { "type": "object", "properties": { "sources": { "type": "array", "items": { "type": "string" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/agent_ProcessorGraphNode" } } } }, "agent_PropertyValue": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "$ref": "#/components/schemas/agent_Json" } } }, "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_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_ProvisioningValidationSummary": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "array", "items": { "type": "string" } } } }, "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_RedactedError": { "required": [ "field", "reason" ], "type": "object", "properties": { "field": { "type": "string" }, "reason": { "type": "string" } } }, "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_RegisterProcessorApiResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } } }, "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_RegisterSchemaRequest": { "required": [ "schema" ], "type": "object", "properties": { "schema": { "type": "string" }, "format": { "type": "string" } } }, "agent_RegisterSchemaResponse": { "required": [ "version", "schemaId" ], "type": "object", "properties": { "version": { "type": "integer" }, "schemaId": { "type": "string" } } }, "agent_RejectionMessage": { "type": "object", "properties": { "rejectionReason": { "type": "string" } } }, "agent_RemoveRunnersRequest": { "required": [ "runners" ], "type": "object", "properties": { "runners": { "type": "array", "items": { "type": "string" }, "description": "A list of runners urls", "minItems": 1 } } }, "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_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_Restore": { "type": "object" }, "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_Results": { "required": [ "datasets" ], "type": "object", "properties": { "datasets": { "$ref": "#/components/schemas/agent_Page_DatasetMatchWithLrn" }, "sourceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/agent_SourceType" } } } }, "agent_RetentionConfig": { "required": [ "size", "time" ], "type": "object", "properties": { "size": { "$ref": "#/components/schemas/agent_DefaultMax" }, "time": { "$ref": "#/components/schemas/agent_DefaultMax" } } }, "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" } } }, "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_RunnerAction": { "type": "string", "enum": [ "Scaled", "Stopped", "Started", "ConfigChange", "Recovered" ] }, "agent_S3Bucket": { "required": [ "bucket" ], "type": "object", "properties": { "bucket": { "type": "string" }, "prefix": { "type": "string" } } }, "agent_S3StorageFormat": { "type": "string", "enum": [ "avro", "parquet", "json" ] }, "agent_SchemaReference": { "required": [ "subjectName", "schemaName", "version" ], "type": "object", "properties": { "subjectName": { "type": "string" }, "schemaName": { "type": "string" }, "version": { "type": "integer" } } }, "agent_SchemaRegistryConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionConfiguration" } } }, "agent_SchemaRegistryConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionConfigurationV2" } } }, "agent_SchemaRegistryConnectionConfiguration": { "required": [ "schemaRegistryUrls" ], "type": "object", "properties": { "schemaRegistryUrls": { "type": "array", "items": { "type": "string" }, "description": "List of schema registry urls", "example": [ "http://sr1:8081" ] }, "username": { "type": "string", "description": "Username for HTTP Basic Authentication", "example": "user" }, "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)", "example": 9581 }, "metricsSsl": { "type": "boolean", "description": "Flag to enable SSL for metrics connections" }, "metricsUsername": { "type": "string", "description": "The username for metrics connections", "example": "username" }, "metricsPassword": { "type": "string", "description": "The password for metrics connections", "format": "password" }, "metricsHttpSuffix": { "type": "string", "description": "HTTP URL suffix for Jolokia metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "type": "integer", "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "type": "object", "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "sr1:8081": "sr1_jmx:9582" }, "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", "example": 5 }, "metricsRateLimitingBackoff": { "type": "integer", "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "agent_SchemaRegistryConnectionConfigurationV2": { "required": [ "schemaRegistryUrls" ], "type": "object", "properties": { "schemaRegistryUrls": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "example": [ "http://sr1:8081" ] } }, "description": "List of schema registry urls", "example": [ "http://sr1:8081" ] }, "username": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "example": "user" } }, "description": "Username for HTTP Basic Authentication", "example": "user" }, "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", "example": 9581 } }, "description": "Default port number for metrics connection (JMX and JOLOKIA)", "example": 9581 }, "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", "example": "username" } }, "description": "The username for metrics connections", "example": "username" }, "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", "example": "/jolokia" } }, "description": "HTTP URL suffix for Jolokia metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "example": { "sr1:8081": "sr1_jmx:9582" }, "additionalProperties": { "type": "string" } } }, "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "sr1:8081": "sr1_jmx:9582" } }, "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", "example": 5 } }, "description": "HTTP retries when 429 is returned for Jolokia metrics", "example": 5 }, "metricsRateLimitingBackoff": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 30000 } }, "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_SchemaRegistryConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_SchemaRegistryConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_SchemaRegistryConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionConfiguration" } } }, "agent_SchemaRegistryConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_SchemaRegistryConnectionConfigurationV2" } } }, "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_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_SetConfig": { "required": [ "compatibility" ], "type": "object", "properties": { "compatibility": { "type": "string" } } }, "agent_SetDescription": { "type": "object", "properties": { "description": { "type": "string" } } }, "agent_SetDescriptionRequest": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 } } }, "agent_SetTags": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/agent_DatasetTag1" } } } }, "agent_SetTagsRequest": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "minLength": 1 } } } }, "agent_SetTopicConfiguration": { "type": "object", "properties": { "configs": { "type": "array", "items": { "$ref": "#/components/schemas/agent_TopicConfigKeyValue" } } } }, "agent_SetTopicPolicy": { "required": [ "config" ], "type": "object", "properties": { "config": { "$ref": "#/components/schemas/agent_TopicPolicyConfig" }, "naming": { "$ref": "#/components/schemas/agent_NamingStrategy" } } }, "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_SinglePartitionOffsetRequest": { "oneOf": [ { "$ref": "#/components/schemas/agent_Absolute" }, { "$ref": "#/components/schemas/agent_End" }, { "$ref": "#/components/schemas/agent_Start" } ] }, "agent_SourceType": { "type": "string", "enum": [ "Kafka", "SchemaRegistrySubject" ] }, "agent_SqlProcessorType": { "type": "string", "enum": [ "PreDaD", "DaD" ] }, "agent_Start": { "type": "object" }, "agent_Start1": { "type": "object", "properties": { "topics": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "agent_StatementPos": { "required": [ "index", "start", "end" ], "type": "object", "properties": { "index": { "type": "integer" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "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_SuitableConnection": { "required": [ "templateName", "name" ], "type": "object", "properties": { "templateName": { "type": "string" }, "name": { "type": "string" } } }, "agent_TableFields": { "required": [ "tableName" ], "type": "object", "properties": { "tableName": { "$ref": "#/components/schemas/agent_TableName" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldName" } } } }, "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_TableName": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "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_TagCount": { "required": [ "name", "count" ], "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "integer", "format": "int64" } } }, "agent_TagCounts": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/agent_TagCount" } } } }, "agent_Target": { "required": [ "cluster" ], "type": "object", "properties": { "cluster": { "type": "string" }, "version": { "type": "string" }, "namespaces": { "type": "array", "items": { "type": "string" } } } }, "agent_TaskDetails": { "required": [ "id", "state", "workerId" ], "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "workerId": { "type": "string" }, "trace": { "type": "string" } } }, "agent_TemplateCategory": { "type": "string", "enum": [ "Connection", "Application", "Channel", "Deployment" ] }, "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_TemplateType": { "type": "string", "enum": [ "Not Applicable", "SQLRunner", "Kubernetes", "InProc", "Connect", "Alert Channel", "Audit Channel", "SchemaRegistry" ] }, "agent_TestConnectionApiRequestV2": { "required": [ "name", "templateName" ], "type": "object", "properties": { "name": { "type": "string" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka", "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" } } }, "agent_Timestamp": { "required": [ "target" ], "type": "object", "properties": { "target": { "type": "string", "format": "date-time" }, "topics": { "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "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_TopicConfigKeyValue": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "agent_TopicField": { "type": "string", "enum": [ "topicName", "partitions", "replication", "isControlTopic", "keyType", "valueType", "totalMessages", "configs", "consumers", "messagesPerSecond", "isMarkedForDeletion", "isCompacted" ] }, "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_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_TopicSchema": { "type": "object", "properties": { "schema": { "type": "string" }, "version": { "type": "integer" }, "inlinedSchema": { "type": "string" } } }, "agent_TopologyNodeType": { "type": "string", "enum": [ "STREAM", "TOPIC", "TABLE", "SELECT", "FILTER", "JOIN", "GROUPBY", "AGGREGATE", "COUNT", "REPARTITION", "MAP", "FLATMAP", "SINK", "SOURCE", "PROCESSOR" ] }, "agent_Unauthorized": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/agent_FieldError" } }, "errorType": { "type": "string" } } }, "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_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_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_UpsertConnectionApiRequestV2": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "templateName": { "type": "string", "minLength": 1 }, "configuration": { "type": "object" } } }, "agent_UsedFormatsResponse": { "type": "object", "properties": { "formats": { "type": "array", "items": { "type": "string" } } } }, "agent_ViewStateAPIResponse": { "required": [ "connections" ], "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/agent_Map_String_List_ConnectionStateResponse" } } }, "agent_ZookeeperConnectionAddRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_ZookeeperConnectionConfiguration" } } }, "agent_ZookeeperConnectionAddRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "the-connection" }, "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_ZookeeperConnectionConfigurationV2" } } }, "agent_ZookeeperConnectionConfiguration": { "required": [ "zookeeperUrls", "zookeeperSessionTimeout", "zookeeperConnectionTimeout" ], "type": "object", "properties": { "zookeeperUrls": { "type": "array", "items": { "type": "string" }, "description": "List of zookeeper urls", "example": [ "zk1:2181" ] }, "zookeeperChrootPath": { "type": "string", "description": "Zookeeper /znode path", "example": "/chroot/path" }, "zookeeperSessionTimeout": { "type": "integer", "description": "Zookeeper connection session timeout", "example": 5000 }, "zookeeperConnectionTimeout": { "type": "integer", "description": "Zookeeper connection timeout", "example": 5000 }, "metricsType": { "type": "string", "description": "Metrics type", "enum": [ "JMX", "JOLOKIAG", "JOLOKIAP" ] }, "metricsPort": { "type": "integer", "description": "Default port number for metrics connection (JMX and JOLOKIA)", "example": 9581 }, "metricsUsername": { "type": "string", "description": "The username for metrics connections", "example": "username" }, "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", "example": "/jolokia" }, "metricsHttpTimeout": { "type": "integer", "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "type": "object", "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "zk1:2181": "zk1_jmx:9585" }, "additionalProperties": { "type": "string" } }, "metricsCustomPortMappings": { "type": "object", "description": "DEPRECATED", "additionalProperties": { "type": "string" } }, "metricsRateLimitingMaxRetries": { "type": "integer", "description": "HTTP retries when 429 is returned for Jolokia metrics", "example": 5 }, "metricsRateLimitingBackoff": { "type": "integer", "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "agent_ZookeeperConnectionConfigurationV2": { "required": [ "zookeeperUrls", "zookeeperSessionTimeout", "zookeeperConnectionTimeout" ], "type": "object", "properties": { "zookeeperUrls": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "example": [ "zk1:2181" ] } }, "description": "List of zookeeper urls", "example": [ "zk1:2181" ] }, "zookeeperChrootPath": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "example": "/chroot/path" } }, "description": "Zookeeper /znode path", "example": "/chroot/path" }, "zookeeperSessionTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "Zookeeper connection session timeout", "example": 5000 }, "zookeeperConnectionTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "Zookeeper connection timeout", "example": 5000 }, "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", "example": 9581 } }, "description": "Default port number for metrics connection (JMX and JOLOKIA)", "example": 9581 }, "metricsUsername": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "example": "username" } }, "description": "The username for metrics connections", "example": "username" }, "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", "example": "/jolokia" } }, "description": "HTTP URL suffix for Jolokia metrics", "example": "/jolokia" }, "metricsHttpTimeout": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5000 } }, "description": "HTTP Request timeout (ms) for Jolokia metrics", "example": 5000 }, "metricsCustomUrlMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "example": { "zk1:2181": "zk1_jmx:9585" }, "additionalProperties": { "type": "string" } } }, "description": "Mapping from node URL to metrics URL, allows overriding metrics target on a per-node basis", "example": { "zk1:2181": "zk1_jmx:9585" } }, "metricsCustomPortMappings": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "DEPRECATED" }, "metricsRateLimitingMaxRetries": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 5 } }, "description": "HTTP retries when 429 is returned for Jolokia metrics", "example": 5 }, "metricsRateLimitingBackoff": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "example": 30000 } }, "description": "The backoff interval (ms) when 429 is returned for Jolokia metrics", "example": 30000 } } }, "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", "example": "the-connection" }, "lrn": { "type": "string" }, "templateVersion": { "type": "integer" }, "templateName": { "type": "string", "description": "The [template](#operation/listConnectionTemplates) of the connection", "example": "Kafka" }, "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_ZookeeperConnectionTestRequest": { "required": [ "name", "configurationObject" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_ZookeeperConnectionTestRequestV2": { "required": [ "name", "configuration" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the connection", "example": "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_ZookeeperConnectionUpsertRequest": { "required": [ "configurationObject" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configurationObject": { "$ref": "#/components/schemas/agent_ZookeeperConnectionConfiguration" } } }, "agent_ZookeeperConnectionUpsertRequestV2": { "required": [ "configuration" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "configuration": { "$ref": "#/components/schemas/agent_ZookeeperConnectionConfigurationV2" } } } } }, "x-tagGroups": [ { "name": "HQ", "tags": [ "hq_environments", "hq_login", "hq_users", "hq_service-accounts", "hq_groups", "hq_roles", "hq_permissions", "hq_settings", "hq_licence", "hq_meta", "hq_k2kapps" ] }, { "name": "Agent", "tags": [ "agent_Datasets", "agent_Kafka", "agent_SchemaRegistry", "agent_Approvals", "agent_DataPolicies", "agent_Deployments", "agent_ApplicationsManagement", "agent_SqlStreaming", "agent_SqlSnapshot", "agent_Alerts", "agent_Audits", "agent_Connections", "agent_KafkaConnections", "agent_ConfluentSchemaRegistryConnections", "agent_AWSGlueSchemaRegistryConnections", "agent_KafkaConnectConnections", "agent_ZookeeperConnections", "agent_KerberosConnections", "agent_ProvisioningState", "agent_Metadata", "agent_BackupRestore", "agent_AsCode", "agent_Kafka Connect" ] } ] }