k2kapps

get

Retrieves a single K2KApp by name.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Path parameters

namestringRequired

Query parameters

expand_metricsbooleanOptional

Includes metrics in the response, if available.

Responses

200

Happy response.

application/json

Responseall of

Extends a K2KApp with additional metrics, if available.

default

Error object.

application/json

get

/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

GET /v0/apps/k2k/{name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2025-10-24T17:09:36.715Z",
    "generation": 1
  },
  "spec": {
    "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
    "targetClusterLRN": "kafka:cluster/my-environment/kafka",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "kubernetes": {
      "commonMetadata": {
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "securityContext": {
        "runAsUser": 1,
        "runAsGroup": 1,
        "runAsNonRoot": true
      },
      "imagePullSecrets": [
        {
          "name": "text"
        }
      ],
      "serviceAccount": "text",
      "image": "text",
      "resources": {
        "requests": {
          "cpu": "text",
          "memory": "text"
        },
        "limits": {
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "replicator": {
      "schemaMapping": true,
      "exactlyOnce": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true
    },
    "paused": true
  },
  "status": {
    "updatedAt": "2025-10-24T17:09:36.715Z",
    "state": "deploying",
    "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
    "statusMessage": "text",
    "observedGeneration": 1,
    "deployment": {
      "inSync": true,
      "managedResources": [
        {
          "name": "text",
          "namespace": "text",
          "kind": "text",
          "status": "text",
          "reason": "text"
        }
      ],
      "pods": [
        {
          "name": "text",
          "namespace": "text",
          "state": "text",
          "reason": "text"
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  },
  "metrics": {
    "topic_metrics": [
      {
        "target_topic_lrn": "text",
        "source_topic_lrn": "text",
        "offsets": {
          "updated_at": "2025-10-24T17:09:36.715Z",
          "offsets": [
            {
              "partition": 1,
              "offset": 1,
              "lag": 1
            }
          ]
        },
        "throughput": {
          "updated_at": "2025-10-24T17:09:36.715Z",
          "input_bytes_per_second": 1,
          "input_records_per_second": 1,
          "output_bytes_per_second": 1,
          "output_records_per_second": 1
        }
      }
    ],
    "state": "unknown",
    "updated_at": "2025-10-24T17:09:36.715Z",
    "error_message": "text"
  }
}

put

Creates a new K2KApp or updates an existing one.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Path parameters

namestringRequired

Body

application/yamlapplication/json

all ofOptional

Defines a K2KApp (Kafka-to-Kafka application).

Responses

201

Happy response.

application/json

Responseall of

Defines a K2KApp (Kafka-to-Kafka application).

default

Error object.

application/json

put

/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

PUT /v0/apps/k2k/{name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 908

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
  id: text
  lrn: text
  creationTimestamp: '2025-10-24T17:09:36.715Z'
  generation: 1
spec:
  sourceClusterLRN: kafka:cluster/my-environment/kafka
  targetClusterLRN: kafka:cluster/my-environment/kafka
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  kubernetes:
    commonMetadata:
      labels:
        ANY_ADDITIONAL_PROPERTY: text
      annotations:
        ANY_ADDITIONAL_PROPERTY: text
    securityContext:
      runAsUser: 1
      runAsGroup: 1
      runAsNonRoot: true
    imagePullSecrets:
      - name: text
    serviceAccount: text
    image: text
    resources:
      requests:
        cpu: text
        memory: text
      limits:
        cpu: text
        memory: text
  replicator:
    schemaMapping: true
    exactlyOnce: true
    autoCreateTopics: true
    autoCreateControlTopics: true
  paused: true
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2025-10-24T17:09:36.715Z",
    "generation": 1
  },
  "spec": {
    "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
    "targetClusterLRN": "kafka:cluster/my-environment/kafka",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "kubernetes": {
      "commonMetadata": {
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "securityContext": {
        "runAsUser": 1,
        "runAsGroup": 1,
        "runAsNonRoot": true
      },
      "imagePullSecrets": [
        {
          "name": "text"
        }
      ],
      "serviceAccount": "text",
      "image": "text",
      "resources": {
        "requests": {
          "cpu": "text",
          "memory": "text"
        },
        "limits": {
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "replicator": {
      "schemaMapping": true,
      "exactlyOnce": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true
    },
    "paused": true
  },
  "status": {
    "updatedAt": "2025-10-24T17:09:36.715Z",
    "state": "deploying",
    "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
    "statusMessage": "text",
    "observedGeneration": 1,
    "deployment": {
      "inSync": true,
      "managedResources": [
        {
          "name": "text",
          "namespace": "text",
          "kind": "text",
          "status": "text",
          "reason": "text"
        }
      ],
      "pods": [
        {
          "name": "text",
          "namespace": "text",
          "state": "text",
          "reason": "text"
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

delete

Deletes a single K2KApp by name.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Path parameters

namestringRequired

Query parameters

forcebooleanOptional

Deletes the K2KApp instantly and skips waiting for deletion of any corresponding K8s resources.

Responses

200

Happy response.

application/json

Responseall of

Defines a K2KApp (Kafka-to-Kafka application).

default

Error object.

application/json

delete

/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

DELETE /v0/apps/k2k/{name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2025-10-24T17:09:36.715Z",
    "generation": 1
  },
  "spec": {
    "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
    "targetClusterLRN": "kafka:cluster/my-environment/kafka",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "kubernetes": {
      "commonMetadata": {
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "securityContext": {
        "runAsUser": 1,
        "runAsGroup": 1,
        "runAsNonRoot": true
      },
      "imagePullSecrets": [
        {
          "name": "text"
        }
      ],
      "serviceAccount": "text",
      "image": "text",
      "resources": {
        "requests": {
          "cpu": "text",
          "memory": "text"
        },
        "limits": {
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "replicator": {
      "schemaMapping": true,
      "exactlyOnce": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true
    },
    "paused": true
  },
  "status": {
    "updatedAt": "2025-10-24T17:09:36.715Z",
    "state": "deploying",
    "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
    "statusMessage": "text",
    "observedGeneration": 1,
    "deployment": {
      "inSync": true,
      "managedResources": [
        {
          "name": "text",
          "namespace": "text",
          "kind": "text",
          "status": "text",
          "reason": "text"
        }
      ],
      "pods": [
        {
          "name": "text",
          "namespace": "text",
          "state": "text",
          "reason": "text"
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

patch

Updates an existing K2KApp.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Path parameters

namestringRequired

Body

application/yamlapplication/json

all ofOptional

Defines a K2KApp (Kafka-to-Kafka application).

Responses

200

Happy response.

application/json

Responseall of

Defines a K2KApp (Kafka-to-Kafka application).

default

Error object.

application/json

patch

/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

PATCH /v0/apps/k2k/{name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 908

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
  id: text
  lrn: text
  creationTimestamp: '2025-10-24T17:09:36.715Z'
  generation: 1
spec:
  sourceClusterLRN: kafka:cluster/my-environment/kafka
  targetClusterLRN: kafka:cluster/my-environment/kafka
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  kubernetes:
    commonMetadata:
      labels:
        ANY_ADDITIONAL_PROPERTY: text
      annotations:
        ANY_ADDITIONAL_PROPERTY: text
    securityContext:
      runAsUser: 1
      runAsGroup: 1
      runAsNonRoot: true
    imagePullSecrets:
      - name: text
    serviceAccount: text
    image: text
    resources:
      requests:
        cpu: text
        memory: text
      limits:
        cpu: text
        memory: text
  replicator:
    schemaMapping: true
    exactlyOnce: true
    autoCreateTopics: true
    autoCreateControlTopics: true
  paused: true
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2025-10-24T17:09:36.715Z",
    "generation": 1
  },
  "spec": {
    "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
    "targetClusterLRN": "kafka:cluster/my-environment/kafka",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "kubernetes": {
      "commonMetadata": {
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "securityContext": {
        "runAsUser": 1,
        "runAsGroup": 1,
        "runAsNonRoot": true
      },
      "imagePullSecrets": [
        {
          "name": "text"
        }
      ],
      "serviceAccount": "text",
      "image": "text",
      "resources": {
        "requests": {
          "cpu": "text",
          "memory": "text"
        },
        "limits": {
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "replicator": {
      "schemaMapping": true,
      "exactlyOnce": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true
    },
    "paused": true
  },
  "status": {
    "updatedAt": "2025-10-24T17:09:36.715Z",
    "state": "deploying",
    "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
    "statusMessage": "text",
    "observedGeneration": 1,
    "deployment": {
      "inSync": true,
      "managedResources": [
        {
          "name": "text",
          "namespace": "text",
          "kind": "text",
          "status": "text",
          "reason": "text"
        }
      ],
      "pods": [
        {
          "name": "text",
          "namespace": "text",
          "state": "text",
          "reason": "text"
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

get

Lists all K2KApps.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Query parameters

expand_metrics_summarybooleanOptional

Includes metrics summaries in the response, if available.

Responses

200

Happy response.

application/json

default

Error object.

application/json

get

/v0/apps/k2k

HTTPcURLJavaScriptPython

GET /v0/apps/k2k HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "apiVersion": "text",
      "kind": "text",
      "metadata": {
        "name": "text",
        "displayName": "text",
        "description": "text",
        "id": "text",
        "lrn": "text",
        "creationTimestamp": "2025-10-24T17:09:36.715Z",
        "generation": 1
      },
      "spec": {
        "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
        "targetClusterLRN": "kafka:cluster/my-environment/kafka",
        "topics": [
          "text"
        ],
        "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
        "kubernetes": {
          "commonMetadata": {
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "annotations": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "securityContext": {
            "runAsUser": 1,
            "runAsGroup": 1,
            "runAsNonRoot": true
          },
          "imagePullSecrets": [
            {
              "name": "text"
            }
          ],
          "serviceAccount": "text",
          "image": "text",
          "resources": {
            "requests": {
              "cpu": "text",
              "memory": "text"
            },
            "limits": {
              "cpu": "text",
              "memory": "text"
            }
          }
        },
        "replicator": {
          "schemaMapping": true,
          "exactlyOnce": true,
          "autoCreateTopics": true,
          "autoCreateControlTopics": true
        },
        "paused": true
      },
      "status": {
        "updatedAt": "2025-10-24T17:09:36.715Z",
        "state": "deploying",
        "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
        "statusMessage": "text",
        "observedGeneration": 1,
        "deployment": {
          "inSync": true,
          "managedResources": [
            {
              "name": "text",
              "namespace": "text",
              "kind": "text",
              "status": "text",
              "reason": "text"
            }
          ],
          "pods": [
            {
              "name": "text",
              "namespace": "text",
              "state": "text",
              "reason": "text"
            }
          ]
        },
        "kafka": {
          "consumerGroup": "text"
        }
      }
    },
    {
      "metrics_summary": {
        "topics_count": 1,
        "partitions_count": 1,
        "total_bytes_per_second_read": 1,
        "total_bytes_per_second_written": 1,
        "total_records_per_second_read": 1,
        "total_records_per_second_written": 1,
        "state": "unknown",
        "updated_at": "2025-10-24T17:09:36.715Z",
        "error_message": "text"
      }
    }
  ]
}

post

Creates a new K2KApp.

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Body

application/yamlapplication/json

all ofOptional

Defines a K2KApp (Kafka-to-Kafka application).

Responses

201

Happy response.

application/json

Responseall of

Defines a K2KApp (Kafka-to-Kafka application).

default

Error object.

application/json

post

/v0/apps/k2k

HTTPcURLJavaScriptPython

POST /v0/apps/k2k HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 908

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
  id: text
  lrn: text
  creationTimestamp: '2025-10-24T17:09:36.715Z'
  generation: 1
spec:
  sourceClusterLRN: kafka:cluster/my-environment/kafka
  targetClusterLRN: kafka:cluster/my-environment/kafka
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  kubernetes:
    commonMetadata:
      labels:
        ANY_ADDITIONAL_PROPERTY: text
      annotations:
        ANY_ADDITIONAL_PROPERTY: text
    securityContext:
      runAsUser: 1
      runAsGroup: 1
      runAsNonRoot: true
    imagePullSecrets:
      - name: text
    serviceAccount: text
    image: text
    resources:
      requests:
        cpu: text
        memory: text
      limits:
        cpu: text
        memory: text
  replicator:
    schemaMapping: true
    exactlyOnce: true
    autoCreateTopics: true
    autoCreateControlTopics: true
  paused: true
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2025-10-24T17:09:36.715Z",
    "generation": 1
  },
  "spec": {
    "sourceClusterLRN": "kafka:cluster/my-environment/kafka",
    "targetClusterLRN": "kafka:cluster/my-environment/kafka",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "kubernetes": {
      "commonMetadata": {
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "securityContext": {
        "runAsUser": 1,
        "runAsGroup": 1,
        "runAsNonRoot": true
      },
      "imagePullSecrets": [
        {
          "name": "text"
        }
      ],
      "serviceAccount": "text",
      "image": "text",
      "resources": {
        "requests": {
          "cpu": "text",
          "memory": "text"
        },
        "limits": {
          "cpu": "text",
          "memory": "text"
        }
      }
    },
    "replicator": {
      "schemaMapping": true,
      "exactlyOnce": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true
    },
    "paused": true
  },
  "status": {
    "updatedAt": "2025-10-24T17:09:36.715Z",
    "state": "deploying",
    "statusLastTransitionAt": "2025-10-24T17:09:36.715Z",
    "statusMessage": "text",
    "observedGeneration": 1,
    "deployment": {
      "inSync": true,
      "managedResources": [
        {
          "name": "text",
          "namespace": "text",
          "kind": "text",
          "status": "text",
          "reason": "text"
        }
      ],
      "pods": [
        {
          "name": "text",
          "namespace": "text",
          "state": "text",
          "reason": "text"
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

get

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

Authorizations

Lenses_HQ_API_bearerAuthLenses_HQ_API_cookieAuth

Responses

default

Error object.

application/json

get

/v1/apps/k2k/live/sse

HTTPcURLJavaScriptPython

GET /v1/apps/k2k/live/sse HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

default

Error object.

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