Streamkap REST API

The Streamkap REST API allows you to programmatically manage your CDC pipelines, sources, destinations, transforms, and more.

Authenticate using a bearer token obtained from the Access Token endpoint with your API client credentials.

Agents

Create, deploy, and manage Flink-based AI agents.

• POST
  Deploy Jar Job/agents/jar
• POST
  Deploy Pyflink Job/agents/pyflink
• POST
  Create Agent From Config/agents/config
• POST
  Cancel Agent/agents/{job_id}/cancel
• POST
  Stop Agent/agents/{job_id}/stop
• POST
  Redeploy Agent/agents/{job_id}/redeploy
• GET
  Get Agent Code/agents/{job_id}/code
• PUT
  Update Agent Code/agents/{job_id}/code
• GET
  Get Agent/agents/{job_id}
• DELETE
  Delete Agent/agents/{job_id}
• GET
  Get Agent Prompt Templates/agents/prompt-templates
• GET
  Get Agent Models/agents/models
• GET
  Get Agent Cluster/agents/cluster
• POST
  List Agent Models Live/agents/models/live
• POST
  Validate Llm Connection/agents/validate-llm
• POST
  Suggest Agent System Prompt/agents/system-prompt-suggestion
• POST
  Test Run Agent/agents/test-run
• POST
  Get Agent Sample Record/agents/sample-record
• POST
  Discover Mcp Tools/agents/mcp/tools
• GET
  Get Agent Connections/agents/connections
• PUT
  Update Agent Connections/agents/connections
• POST
  Create Agent Llm Connection/agents/connections/llm
• DELETE
  Delete Agent Llm Connection/agents/connections/llm/{connection_id}
• PATCH
  Patch Agent Llm Connection/agents/connections/llm/{connection_id}
• POST
  Create Agent Mcp Connection/agents/connections/mcp
• DELETE
  Delete Agent Mcp Connection/agents/connections/mcp/{name}
• PATCH
  Patch Agent Mcp Connection/agents/connections/mcp/{name}
• POST
  Create Agent Http Connection/agents/connections/http
• DELETE
  Delete Agent Http Connection/agents/connections/http/{connection_id}
• PATCH
  Patch Agent Http Connection/agents/connections/http/{connection_id}
• POST
  Create Agent Vector Store Connection/agents/connections/vectorStore
• DELETE
  Delete Agent Vector Store Connection/agents/connections/vectorStore/{connection_id}
• PATCH
  Patch Agent Vector Store Connection/agents/connections/vectorStore/{connection_id}
• GET
  List Agents/agents
• GET
  Get Agent Status/agents/{job_id}/status
• GET
  Get Agent Logs/agents/{job_id}/logs
• GET
  Get Agent Config/agents/{job_id}/config
• PUT
  Update Agent Config/agents/{job_id}/config
• GET
  List Agent Config History/agents/{job_id}/config/history
• GET
  Get Agent Config History Entry/agents/{job_id}/config/history/{version}
• POST
  Rollback Agent Config/agents/{job_id}/config/rollback

Agents Observability

Read-only views over the MCP audit log: agent rollup, sessions, spans, histograms, external-agent verify.

• GET
  Get Observability Agents/agentic/observability/agents
• GET
  Get Observability Sessions/agentic/observability/sessions
• GET
  Get Observability Session Spans/agentic/observability/sessions/{session_id}
• GET
  Get Observability Session Transcript/agentic/observability/sessions/{session_id}/transcript
• GET
  Get Observability Tools/agentic/observability/tools
• GET
  Get Observability External Verify/agentic/observability/external/verify
• GET
  Get Observability Iterations/agentic/observability/iterations
• GET
  Get Observability Iterations Histogram/agentic/observability/iterations/histogram
• GET
  Get Observability Iteration Detail/agentic/observability/iterations/{iteration_id}
• GET
  Get Observability Histogram/agentic/observability/histogram
• GET
  Get Observability Logs/agentic/observability/logs
• GET
  Get Observability Logs Histogram/agentic/observability/logs/histogram
• GET
  Get Observability Logs Exceptions/agentic/observability/logs/exceptions

Alerts

Manage alert subscribers, preferences, and notification credentials.

• GET
  Get Subscribers/alerts/subscribers/{subscriberId}
• PUT
  Update Subscribers/alerts/subscribers/{subscriberId}
• GET
  Get Subscriber Preferences/alerts/subscribers/{subscriberId}/preferences
• PUT
  Update Subscriber Credentials/alerts/subscribers/{subscriberId}/credentials
• DELETE
  Delete Subscriber Credentials/alerts/subscribers/{subscriberId}/credentials
• POST
  Summarise Alert/alerts/summary

Authentication

Obtain and refresh access tokens, manage client credentials and roles.

• POST
  Access Token/auth/access-token
• POST
  Switch Tenant/auth/switch-tenant
• POST
  Refresh Access Token/auth/access-token/refresh
• GET
  Whoami/auth/whoami
• GET
  Get Roles/auth/roles
• GET
  Get Mcp Tools/auth/tools
• GET
  Get Permissions/auth/permissions
• GET
  List Client Credentials/auth/client-credentials
• POST
  Create Client Credential/auth/client-credentials
• DELETE
  Delete Client Credential/auth/client-credentials/{client_id}
• PATCH
  Update Client Credential/auth/client-credentials/{client_id}

Consumer Groups

List, inspect, and reset Kafka consumer group offsets.

• GET
  List Consumer Groups/consumer-groups
• GET
  Get Consumer Group Detail/consumer-groups/{group_id}
• POST
  Reset Consumer Group Offsets/consumer-groups/{group_id}/reset-offsets

Dashboard

Retrieve organisation-level statistics and overview data.

• GET
  Get Organisation Statistics/dashboard/organisation/statistics
• GET
  Get dashboard health summary/dashboard/health
• GET
  Get dashboard lineage groups/dashboard/lineage
• GET
  Get dashboard lineage topics/dashboard/lineage/topics
• POST
  Batch fetch topics for multiple entities/dashboard/lineage/topics/batch
• POST
  Get latest QA row counts for topics/dashboard/qa-counts

Destinations

Create, configure, and manage data destinations and their lifecycle.

• POST
  Search destinations (POST)/destinations/search
• GET
  Get Destinations/destinations
• POST
  Create New Destination/destinations
• GET
  List All Destinations Brief/destinations/brief
• GET
  Get Destinations Connectors/destinations/connectors
• POST
  Deploy Destination/destinations/{destination_id}/deploy
• POST
  Explain Destination Error/destinations/{destination_id}/explain-error
• GET
  Get Metrics For Destination/destinations/{destination_id}/metrics
• GET
  Get Metrics For Destinations/destinations/metrics
• POST
  Get destination metrics (POST)/destinations/metrics
• GET
  Get Destination Configuration/destinations/configuration
• GET
  Destination Configs/destinations/common_configurations
• GET
  Get Sample Scripts For Destinations/destinations/sample_scripts
• POST
  Destination Invite/destinations/invite
• PUT
  Update Bulk Destinations/destinations/bulk_update
• DELETE
  Bulk Delete Destinations/destinations/bulk/delete
• PUT
  Bulk Stop Destinations/destinations/bulk/stop
• POST
  Bulk Reset Destinations/destinations/bulk/reset
• PUT
  Bulk Resume Destinations/destinations/bulk/resume
• PUT
  Resume Existing Destination/destinations/{destination_id}/resume
• PUT
  Pause Existing Destination/destinations/{destination_id}/pause
• PUT
  Stop Existing Destination/destinations/{destination_id}/stop
• POST
  Restart Existing Destination/destinations/{destination_id}/restart
• POST
  Reset Existing Destination/destinations/{destination_id}/reset
• POST
  Restart Destination Task Api/destinations/{destination_id}/restart_task
• GET
  Get Destination/destinations/{destination_id}
• PUT
  Update Existing Destination/destinations/{destination_id}
• DELETE
  Delete Existing Destination/destinations/{destination_id}
• GET
  Get Destination Config History/destinations/{destination_id}/config-history
• GET
  Get Destination Config Comparison/destinations/{destination_id}/config-history/compare-to-original

Kafka Access

Manage Kafka users and their access permissions.

• GET
  List Kafka Users/kafka-access/kafka-users
• POST
  Create New Kafka User/kafka-access/kafka-users
• PUT
  Update Kafka User/kafka-access/kafka-users/{username}
• DELETE
  Delete Kafka User/kafka-access/kafka-users/{username}

Logs

Query and summarise system logs.

• POST
  Get Logs/logs
• POST
  Summarise Log/logs/summary
• POST
  Get Logs Histogram/logs/histogram
• POST
  Get Logs Count/logs/count

Pipelines

Create, configure, and manage CDC pipelines and their lifecycle.

• POST
  Search pipelines (POST)/pipelines/search
• GET
  Get Pipelines/pipelines
• POST
  Create New Pipeline/pipelines
• GET
  List All Pipelines Brief/pipelines/brief
• POST
  Trigger Pipeline Row Level Audit/pipelines/row-level-audit
• GET
  Get Metrics For Pipeline/pipelines/{pipeline_id}/metrics
• GET
  Get Metrics For Pipelines/pipelines/metrics
• POST
  Get pipeline metrics (POST)/pipelines/metrics
• GET
  Get Logs For Pipelines/pipelines/logs
• GET
  Get Pipeline/pipelines/{pipeline_id}
• PUT
  Update Existing Pipeline/pipelines/{pipeline_id}
• DELETE
  Delete Existing Pipeline/pipelines/{pipeline_id}
• PUT
  Update Bulk Pipelines/pipelines/bulk_update
• DELETE
  Bulk Delete Pipelines/pipelines/bulk/delete

Project Keys

Manage project keys that bundle API credentials and optional Kafka access.

• GET
  List Project Keys/project-keys
• POST
  Create Project Key/project-keys
• GET
  Get Project Key/project-keys/{project_key_id}
• DELETE
  Delete Project Key/project-keys/{project_key_id}
• PATCH
  Update Project Key/project-keys/{project_key_id}
• GET
  Get Project Key Mcp Config/project-keys/{project_key_id}/mcp-config
• POST
  Enable Project Key Agentic/project-keys/{project_key_id}/enable-agentic
• POST
  Disable Project Key Agentic/project-keys/{project_key_id}/disable-agentic

Schema Registry

Browse schema subjects, versions, and retrieve schema definitions.

• GET
  List Schema Subjects/schema-registry/subjects
• GET
  List Subject Versions/schema-registry/subjects/{subject}/versions
• GET
  Get Schema By Version/schema-registry/subjects/{subject}/versions/{version}
• GET
  Get Schema By Id/schema-registry/schemas/{schema_id}

Services

View and switch service metadata.

• GET
  Get All Service Metadata/services/all
• PUT
  Switch/services/switch

Sources

Create, configure, and manage data sources, snapshots, and their lifecycle.

• POST
  Search sources (POST)/sources/search
• GET
  Get Sources/sources
• POST
  Create New Source/sources
• GET
  List All Sources Brief/sources/brief
• GET
  Get Sources Connectors/sources/connectors
• POST
  Deploy Source/sources/{source_id}/deploy
• POST
  Explain Source Error/sources/{source_id}/explain-error
• GET
  Get Metrics For Source/sources/{source_id}/metrics
• GET
  Get Metrics For Sources/sources/metrics
• POST
  Get source metrics (POST)/sources/metrics
• GET
  Get Source Configuration/sources/configuration
• GET
  Source Configs/sources/common_configurations
• POST
  Source Invite/sources/invite
• POST
  Execute Incremental Snapshot/sources/execute_incremental_snapshot
• POST
  Execute Blocking Snapshot/sources/execute_blocking_snapshot
• POST
  Execute Parallel Snapshot/sources/execute_parallel_snapshot
• POST
  Stop Incremental Snapshot/sources/stop_incremental_snapshot
• POST
  Stop Blocking Snapshot/sources/stop_blocking_snapshot
• POST
  Execute Snapshot/sources/snapshot
• POST
  Cancel Snapshot/sources/cancel_snapshot
• PUT
  Update Bulk Sources/sources/bulk_update
• DELETE
  Bulk Delete Sources/sources/bulk/delete
• POST
  Bulk Execute Snapshot Sources/sources/bulk/snapshot
• POST
  Bulk Parallel Snapshot Sources/sources/bulk/parallel-snapshot
• POST
  Bulk Stop Snapshot Sources/sources/bulk/stop-snapshot
• PUT
  Bulk Stop Sources/sources/bulk/stop
• POST
  Bulk Reset Sources/sources/bulk/reset
• PUT
  Bulk Resume Sources/sources/bulk/resume
• PUT
  Pause Existing Source/sources/{source_id}/pause
• PUT
  Resume Existing Source/sources/{source_id}/resume
• PUT
  Stop Existing Source/sources/{source_id}/stop
• POST
  Restart Existing Source/sources/{source_id}/restart
• POST
  Reset Existing Source/sources/{source_id}/reset
• POST
  Restart Source Task Api/sources/{source_id}/restart_task
• GET
  Get Source/sources/{source_id}
• PUT
  Update Existing Source/sources/{source_id}
• DELETE
  Delete Existing Source/sources/{source_id}
• GET
  Get Source Config History/sources/{source_id}/config-history
• GET
  Get Source Config Comparison/sources/{source_id}/config-history/compare-to-original

Tags

Create, update, and manage resource tags for organisation.

• POST
  Search tags (POST)/tags/search
• GET
  Get Tags For Specific Tenant/tags
• POST
  Create Tag/tags
• GET
  Get Tags By Type/tags/{tag_type}
• PUT
  Update Tag/tags/{tag_id}
• DELETE
  Delete Tag/tags/{tag_id}

Topics

Browse topic details, statistics, configurations, metrics, and messages.

• POST
  Search topics (POST)/topics/details/search
• GET
  List all topics/topics/details
• GET
  List topics grouped by connector/entity/topics/details/grouped
• GET
  Get topic statistics/topics/statistics
• GET
  Get topic configurations/topics/configs
• GET
  Get topic metrics/topics/metrics
• POST
  Per-topic Kafka metadata for the topics list/topics/table_metrics
• GET
  Get topic messages/topics/messages
• GET
  Get a single topic message value/topics/messages/value
• GET
  Get latest raw metrics for a topic/topics/{topic_id}/raw-metrics
• POST
  Bulk Snapshot Topics/topics/bulk/snapshot
• POST
  Bulk Stop Snapshot Topics/topics/bulk/stop-snapshot
• GET
  Browse topics for SQL Studio/topics/catalog
• GET
  Browse topics grouped by source/topics/catalog/grouped
• GET
  Get schema for a single topic/topics/catalog/schema
• POST
  Execute SQL query against Kafka topics/topics/query
• POST
  Create a new Kafka topic/topics
• POST
  Publish a record to a Streamkap/KC internal topic (local + admin app only)/topics/internal/publish
• GET
  Get comprehensive topic information/topics/{topic_id}
• PUT
  Update Topic Api/topics/{topic_id}
• DELETE
  Delete Topic Api/topics/{topic_id}
• PUT
  Update Bulk Topics/topics/bulk_update

Transforms

Create, deploy, and manage data transforms, unit tests, and implementation details.

• POST
  Search transforms (POST)/transforms/search
• GET
  Get Full Transforms/transforms
• PUT
  Update Transform/transforms
• POST
  Create New Transform/transforms
• DELETE
  Delete Existing Transform/transforms
• GET
  List All Transforms Brief/transforms/brief
• GET
  Get Topics For Pattern/transforms/topics-for-pattern/{topic_pattern}/{java_replacement_pattern}
• PUT
  Update Bulk Transforms/transforms/bulk_update
• POST
  Bulk Clone Transforms/transforms/bulk/clone
• DELETE
  Bulk Delete Transforms/transforms/bulk/delete
• PUT
  Set Input Output Topics/transforms/{transforms_id}/set-input-output-topics/{topic_pattern}/{java_replacement_pattern}
• PUT
  Clear Output Topics/transforms/{transforms_id}/clear-output-topics/{output_topic_pattern}
• GET
  Get Output Topics For Transform/transforms/{transforms_id}/output-topics
• GET
  Get Errors Transform/transforms/{transforms_id}/errors
• GET
  Get Jobs Status/transforms/{transforms_id}/job_status
• GET
  Get Transforms Implementation Details/transforms/{transforms_id}/implementation_details
• PUT
  Put Transforms Implementation Details/transforms/{transforms_id}/implementation_details
• PUT
  Run Unit Tests/transforms/{transforms_id}/run-unit-tests/{version_id}
• PUT
  Deploy Job Preview/transforms/{transforms_id}/deploy-job-preview/{version_id}
• PUT
  Deploy Job Live/transforms/{transforms_id}/deploy-job-live/{version_id}
• GET
  Get Transform Details/transforms/details
• GET
  Get Transform Configs/transforms/configs
• POST
  Clone Transform/transforms/{transform_id}/clone
• POST
  Create New Transform With Full Process/transforms/full-process
• GET
  Get Transform Metrics/transforms/metrics
• GET
  Get Full Transforms With Id/transforms/{transform_id}
• GET
  Get Transform Dlq Errors/transforms/{transform_id}/dlq
• GET
  Get Transform Checkpoints/transforms/{transform_id}/checkpoints

Usage

• GET
  Get Usage Metrics/billing/usage/metrics
• POST
  Get usage metrics (POST)/billing/usage/metrics
• GET
  Get Usage Summary/billing/usage/summary
• GET
  Get Usage Export/billing/usage/export

other

• GET
  Get Tenant Trees/other/tenant/trees

Cluster Scaling

• GET
  Is Cluster Scaling Enabled/cluster/enabled
• GET
  Get Cluster Status/cluster/status
• POST
  Scale Cluster/cluster/scale
• GET
  Get Scale Operation Status/cluster/scale/{operation_id}
• POST
  Cancel Scale Operation/cluster/scale/{operation_id}/cancel

Knowledge Bases

• POST
  Create Knowledge Base/knowledge-bases/config
• GET
  List Knowledge Bases/knowledge-bases
• GET
  Get Knowledge Base/knowledge-bases/{kb_id}
• DELETE
  Delete Knowledge Base/knowledge-bases/{kb_id}
• POST
  Cancel Knowledge Base/knowledge-bases/{kb_id}/cancel
• POST
  Stop Knowledge Base/knowledge-bases/{kb_id}/stop
• POST
  Retrieve Knowledge Base/knowledge-bases/{kb_id}/retrieve

Flink Jobs

• POST
  Deploy Jar Job/flink_jobs/jar
• POST
  Deploy Pyflink Job/flink_jobs/pyflink
• GET
  List Flink Jobs/flink_jobs/
• GET
  Get Flink Job/flink_jobs/{job_id}
• DELETE
  Delete Flink Job/flink_jobs/{job_id}
• GET
  Get Flink Job Status/flink_jobs/{job_id}/status
• POST
  Cancel Flink Job/flink_jobs/{job_id}/cancel
• POST
  Restart Flink Job/flink_jobs/{job_id}/restart