K2K Apps

Kafka 2 Kafka application management

get

Retrieves a single K2KApp by name.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

namestringRequired

Query parameters

expand_metricsbooleanOptional

Includes metrics in the response, if available.

Responses

200

Happy response.

application/json

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

apiVersionstring · min: 1Required

kindstring · min: 1Required

default

Error object.

application/json

get/api/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

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

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2026-07-17T21:03:48.383Z",
    "generation": 1
  },
  "spec": {
    "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
    "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "replicas": 1,
    "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,
      "headerReplication": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true,
      "keepRecordCreationTimestamp": true,
      "errorHandling": {
        "onCommitSyncTimeout": "fail",
        "onControlMessageDeserializationError": "fail"
      },
      "tracingHeaders": {
        "partition": true,
        "offset": true,
        "topic": true,
        "pipeline": true
      },
      "coordination": {
        "commit": {
          "topic": "text",
          "syncTimeoutSeconds": 1,
          "batchSize": 1,
          "batchTimeoutSeconds": 1
        },
        "assignment": {
          "topic": "text",
          "graceWindowSeconds": 1,
          "fencingMaxParallelism": 1
        }
      },
      "bidirectional": {
        "enabled": true,
        "mode": "cluster",
        "headerName": "text"
      }
    },
    "paused": true,
    "configOverrides": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "status": {
    "updatedAt": "2026-07-17T21:03:48.383Z",
    "state": "deploying",
    "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
    "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",
          "lastTermination": {
            "message": "text",
            "time": "2026-07-17T21:03:48.383Z"
          }
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  },
  "metrics": {
    "state": "unknown",
    "updated_at": "2026-07-17T21:03:48.383Z",
    "error_message": "text",
    "source_topics": [
      {
        "lrn": "text",
        "name": "text",
        "throughput": {
          "updated_at": "2026-07-17T21:03:48.383Z",
          "bytes_per_second": 1,
          "records_per_second": 1
        },
        "offsets": {
          "updated_at": "2026-07-17T21:03:48.383Z",
          "partitions": [
            {
              "partition": 0,
              "log_end_offset": 1
            }
          ]
        }
      }
    ],
    "destination_topics": [
      {
        "lrn": "text",
        "name": "text",
        "throughput": {
          "updated_at": "2026-07-17T21:03:48.383Z",
          "bytes_per_second": 1,
          "records_per_second": 1
        },
        "offsets": {
          "updated_at": "2026-07-17T21:03:48.383Z",
          "partitions": [
            {
              "partition": 0,
              "log_end_offset": 1,
              "lag": 1
            }
          ]
        }
      }
    ],
    "errors": [
      "text"
    ]
  }
}

put

Creates a new K2KApp or updates an existing one.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

namestringRequired

Body

application/yamlapplication/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

Responses

201

Happy response.

application/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

default

Error object.

application/json

put/api/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

PUT /api/v0/apps/k2k/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 1426

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
spec:
  sourceKafkaLRN: environments:kafka-connection/my-source-environment/plaintext
  targetKafkaLRN: environments:kafka-connection/my-target-environment/plaintext
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  replicas: 1
  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
    headerReplication: true
    autoCreateTopics: true
    autoCreateControlTopics: true
    keepRecordCreationTimestamp: true
    errorHandling:
      onCommitSyncTimeout: fail
      onControlMessageDeserializationError: fail
    tracingHeaders:
      partition: true
      offset: true
      topic: true
      pipeline: true
    coordination:
      commit:
        topic: text
        syncTimeoutSeconds: 1
        batchSize: 1
        batchTimeoutSeconds: 1
      assignment:
        topic: text
        graceWindowSeconds: 1
        fencingMaxParallelism: 1
    bidirectional:
      enabled: true
      mode: cluster
      headerName: text
  paused: true
  configOverrides:
    ANY_ADDITIONAL_PROPERTY: anything
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2026-07-17T21:03:48.383Z",
    "generation": 1
  },
  "spec": {
    "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
    "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "replicas": 1,
    "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,
      "headerReplication": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true,
      "keepRecordCreationTimestamp": true,
      "errorHandling": {
        "onCommitSyncTimeout": "fail",
        "onControlMessageDeserializationError": "fail"
      },
      "tracingHeaders": {
        "partition": true,
        "offset": true,
        "topic": true,
        "pipeline": true
      },
      "coordination": {
        "commit": {
          "topic": "text",
          "syncTimeoutSeconds": 1,
          "batchSize": 1,
          "batchTimeoutSeconds": 1
        },
        "assignment": {
          "topic": "text",
          "graceWindowSeconds": 1,
          "fencingMaxParallelism": 1
        }
      },
      "bidirectional": {
        "enabled": true,
        "mode": "cluster",
        "headerName": "text"
      }
    },
    "paused": true,
    "configOverrides": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "status": {
    "updatedAt": "2026-07-17T21:03:48.383Z",
    "state": "deploying",
    "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
    "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",
          "lastTermination": {
            "message": "text",
            "time": "2026-07-17T21:03:48.383Z"
          }
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

delete

Deletes a single K2KApp by name.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

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

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

default

Error object.

application/json

delete/api/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

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

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2026-07-17T21:03:48.383Z",
    "generation": 1
  },
  "spec": {
    "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
    "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "replicas": 1,
    "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,
      "headerReplication": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true,
      "keepRecordCreationTimestamp": true,
      "errorHandling": {
        "onCommitSyncTimeout": "fail",
        "onControlMessageDeserializationError": "fail"
      },
      "tracingHeaders": {
        "partition": true,
        "offset": true,
        "topic": true,
        "pipeline": true
      },
      "coordination": {
        "commit": {
          "topic": "text",
          "syncTimeoutSeconds": 1,
          "batchSize": 1,
          "batchTimeoutSeconds": 1
        },
        "assignment": {
          "topic": "text",
          "graceWindowSeconds": 1,
          "fencingMaxParallelism": 1
        }
      },
      "bidirectional": {
        "enabled": true,
        "mode": "cluster",
        "headerName": "text"
      }
    },
    "paused": true,
    "configOverrides": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "status": {
    "updatedAt": "2026-07-17T21:03:48.383Z",
    "state": "deploying",
    "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
    "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",
          "lastTermination": {
            "message": "text",
            "time": "2026-07-17T21:03:48.383Z"
          }
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

patch

Updates an existing K2KApp.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

namestringRequired

Body

application/yamlapplication/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

Responses

200

Happy response.

application/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

default

Error object.

application/json

patch/api/v0/apps/k2k/{name}

HTTPcURLJavaScriptPython

PATCH /api/v0/apps/k2k/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 1426

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
spec:
  sourceKafkaLRN: environments:kafka-connection/my-source-environment/plaintext
  targetKafkaLRN: environments:kafka-connection/my-target-environment/plaintext
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  replicas: 1
  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
    headerReplication: true
    autoCreateTopics: true
    autoCreateControlTopics: true
    keepRecordCreationTimestamp: true
    errorHandling:
      onCommitSyncTimeout: fail
      onControlMessageDeserializationError: fail
    tracingHeaders:
      partition: true
      offset: true
      topic: true
      pipeline: true
    coordination:
      commit:
        topic: text
        syncTimeoutSeconds: 1
        batchSize: 1
        batchTimeoutSeconds: 1
      assignment:
        topic: text
        graceWindowSeconds: 1
        fencingMaxParallelism: 1
    bidirectional:
      enabled: true
      mode: cluster
      headerName: text
  paused: true
  configOverrides:
    ANY_ADDITIONAL_PROPERTY: anything
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2026-07-17T21:03:48.383Z",
    "generation": 1
  },
  "spec": {
    "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
    "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "replicas": 1,
    "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,
      "headerReplication": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true,
      "keepRecordCreationTimestamp": true,
      "errorHandling": {
        "onCommitSyncTimeout": "fail",
        "onControlMessageDeserializationError": "fail"
      },
      "tracingHeaders": {
        "partition": true,
        "offset": true,
        "topic": true,
        "pipeline": true
      },
      "coordination": {
        "commit": {
          "topic": "text",
          "syncTimeoutSeconds": 1,
          "batchSize": 1,
          "batchTimeoutSeconds": 1
        },
        "assignment": {
          "topic": "text",
          "graceWindowSeconds": 1,
          "fencingMaxParallelism": 1
        }
      },
      "bidirectional": {
        "enabled": true,
        "mode": "cluster",
        "headerName": "text"
      }
    },
    "paused": true,
    "configOverrides": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "status": {
    "updatedAt": "2026-07-17T21:03:48.383Z",
    "state": "deploying",
    "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
    "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",
          "lastTermination": {
            "message": "text",
            "time": "2026-07-17T21:03:48.383Z"
          }
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

get

Lists all K2KApps.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Query parameters

expand_metrics_summarybooleanOptional

Includes metrics summaries in the response, if available.

Responses

200

Happy response.

application/json

Contains K2KApps (Kafka-to-Kafka applications).

default

Error object.

application/json

get/api/v0/apps/k2k

HTTPcURLJavaScriptPython

GET /api/v0/apps/k2k HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "apiVersion": "text",
      "kind": "text",
      "metadata": {
        "name": "text",
        "displayName": "text",
        "description": "text",
        "id": "text",
        "lrn": "text",
        "creationTimestamp": "2026-07-17T21:03:48.383Z",
        "generation": 1
      },
      "spec": {
        "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
        "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
        "topics": [
          "text"
        ],
        "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
        "replicas": 1,
        "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,
          "headerReplication": true,
          "autoCreateTopics": true,
          "autoCreateControlTopics": true,
          "keepRecordCreationTimestamp": true,
          "errorHandling": {
            "onCommitSyncTimeout": "fail",
            "onControlMessageDeserializationError": "fail"
          },
          "tracingHeaders": {
            "partition": true,
            "offset": true,
            "topic": true,
            "pipeline": true
          },
          "coordination": {
            "commit": {
              "topic": "text",
              "syncTimeoutSeconds": 1,
              "batchSize": 1,
              "batchTimeoutSeconds": 1
            },
            "assignment": {
              "topic": "text",
              "graceWindowSeconds": 1,
              "fencingMaxParallelism": 1
            }
          },
          "bidirectional": {
            "enabled": true,
            "mode": "cluster",
            "headerName": "text"
          }
        },
        "paused": true,
        "configOverrides": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "status": {
        "updatedAt": "2026-07-17T21:03:48.383Z",
        "state": "deploying",
        "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
        "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",
              "lastTermination": {
                "message": "text",
                "time": "2026-07-17T21:03:48.383Z"
              }
            }
          ]
        },
        "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": "2026-07-17T21:03:48.383Z",
        "error_message": "text"
      }
    }
  ]
}

post

Creates a new K2KApp.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Body

application/yamlapplication/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

Responses

201

Happy response.

application/json

Contains common fields shared by HQ manifests.

apiVersionstring · min: 1Required

kindstring · min: 1Required

default

Error object.

application/json

post/api/v0/apps/k2k

HTTPcURLJavaScriptPython

POST /api/v0/apps/k2k HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 1426

"apiVersion: text
kind: text
metadata:
  name: text
  displayName: text
  description: text
spec:
  sourceKafkaLRN: environments:kafka-connection/my-source-environment/plaintext
  targetKafkaLRN: environments:kafka-connection/my-target-environment/plaintext
  topics:
    - text
  deploymentNamespaceLRN: kubernetes:namespace/my-environment/incluster/my-namespace
  replicas: 1
  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
    headerReplication: true
    autoCreateTopics: true
    autoCreateControlTopics: true
    keepRecordCreationTimestamp: true
    errorHandling:
      onCommitSyncTimeout: fail
      onControlMessageDeserializationError: fail
    tracingHeaders:
      partition: true
      offset: true
      topic: true
      pipeline: true
    coordination:
      commit:
        topic: text
        syncTimeoutSeconds: 1
        batchSize: 1
        batchTimeoutSeconds: 1
      assignment:
        topic: text
        graceWindowSeconds: 1
        fencingMaxParallelism: 1
    bidirectional:
      enabled: true
      mode: cluster
      headerName: text
  paused: true
  configOverrides:
    ANY_ADDITIONAL_PROPERTY: anything
"

application/yamlapplication/json

{
  "apiVersion": "text",
  "kind": "text",
  "metadata": {
    "name": "text",
    "displayName": "text",
    "description": "text",
    "id": "text",
    "lrn": "text",
    "creationTimestamp": "2026-07-17T21:03:48.383Z",
    "generation": 1
  },
  "spec": {
    "sourceKafkaLRN": "environments:kafka-connection/my-source-environment/plaintext",
    "targetKafkaLRN": "environments:kafka-connection/my-target-environment/plaintext",
    "topics": [
      "text"
    ],
    "deploymentNamespaceLRN": "kubernetes:namespace/my-environment/incluster/my-namespace",
    "replicas": 1,
    "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,
      "headerReplication": true,
      "autoCreateTopics": true,
      "autoCreateControlTopics": true,
      "keepRecordCreationTimestamp": true,
      "errorHandling": {
        "onCommitSyncTimeout": "fail",
        "onControlMessageDeserializationError": "fail"
      },
      "tracingHeaders": {
        "partition": true,
        "offset": true,
        "topic": true,
        "pipeline": true
      },
      "coordination": {
        "commit": {
          "topic": "text",
          "syncTimeoutSeconds": 1,
          "batchSize": 1,
          "batchTimeoutSeconds": 1
        },
        "assignment": {
          "topic": "text",
          "graceWindowSeconds": 1,
          "fencingMaxParallelism": 1
        }
      },
      "bidirectional": {
        "enabled": true,
        "mode": "cluster",
        "headerName": "text"
      }
    },
    "paused": true,
    "configOverrides": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "status": {
    "updatedAt": "2026-07-17T21:03:48.383Z",
    "state": "deploying",
    "statusLastTransitionAt": "2026-07-17T21:03:48.383Z",
    "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",
          "lastTermination": {
            "message": "text",
            "time": "2026-07-17T21:03:48.383Z"
          }
        }
      ]
    },
    "kafka": {
      "consumerGroup": "text"
    }
  }
}

Update Consumer Group Offsets for multiple partitions

put

Update the committed offsets for multiple topic partitions for a given K2K application.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

namestringRequired

The unique name for the K2K application.

Example: my-app-prod

Body

application/json

Defines the request body for updating K2K offsets, containing an array of topic-partition-offset tuples.

Responses

200

Offsets successfully updated.

application/json

application_namestringRequiredExample: my-app-prod

default

Error object.

application/json

put/api/v0/apps/k2k/{name}/position/offsets

HTTPcURLJavaScriptPython

PUT /api/v0/apps/k2k/{name}/position/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "offsets": [
    {
      "topic_name": "user-login-events",
      "partition": 0,
      "offset": 12345
    }
  ]
}

{
  "application_name": "my-app-prod",
  "updated_partitions": [
    {
      "topic_name": "user-login-events",
      "partition": 0,
      "offset": 12345
    }
  ]
}

Update Consumer Group Offsets based on timestamp

put

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.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

namestringRequired

The unique name for the K2K application.

Example: my-app-prod

Body

application/json

Defines the request body for updating K2K offsets based on a timestamp for multiple topics.

timestampstring · date-timeRequired

RFC3339 timestamp to seek offsets to.

Example: 2025-01-14T10:03:00Z

topicsstring[] · min: 1Required

List of Kafka topic names to update offsets for.

Example: ["user-login-events","orders","payments"]

Responses

200

Offsets successfully updated.

application/json

application_namestringRequiredExample: my-app-prod

default

Error object.

application/json

put/api/v0/apps/k2k/{name}/position/timestamp

HTTPcURLJavaScriptPython

PUT /api/v0/apps/k2k/{name}/position/timestamp HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "timestamp": "2025-01-14T10:03:00Z",
  "topics": [
    "user-login-events",
    "orders",
    "payments"
  ]
}

{
  "application_name": "my-app-prod",
  "updated_partitions": [
    {
      "topic_name": "user-login-events",
      "partition": 0,
      "offset": 12345
    }
  ]
}

get

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

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Responses

default

Error object.

application/json

Implements the RFC7807 "Problem Details", see https://www.rfc-editor.org/rfc/rfc7807.

typestring · enumOptional

Enumerates possible error types.

Possible values:

titlestringRequired

Describes the problem in a human readable fashion.

statusintegerRequired

Is a copy of the http status code.

sso_urlstringOptional

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

request_idstringOptional

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

get/api/v1/apps/k2k/live/sse

HTTPcURLJavaScriptPython

GET /api/v1/apps/k2k/live/sse HTTP/1.1
Host: api.example.com
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",
      "pointer": "text"
    }
  ],
  "sso_url": "text",
  "request_id": "text"
}